Skip to main content
GET
Get a contact

Authorizations

Authorization
string
header
required

A Parley API key.

Path Parameters

id
string
required

The contact ID.

Minimum string length: 1

Response

OK

id
string
required

The contact ID.

Minimum string length: 1
firstName
string
required

First name. Empty for some contacts created from email.

lastName
string
required

Last name. Empty for some contacts created from email.

emails
string[]
required

Email addresses, lowercased. A contact has at most one address for now.

account
object | null
required

The account the contact belongs to, or null.

projectCount
integer
required

How many projects you can see are linked to the contact. List them by filtering projects by contactId. Linking or unlinking a project doesn't change the contact's updatedAt.

Required range: 0 <= x <= 9007199254740991
createdAt
string<date-time>
required

When the contact was created.

updatedAt
string<date-time>
required

When the contact was last updated, including changes to its email address. Links to projects and field value changes do not change it.

fields
object
required

Custom field values, keyed by field name, with a key for every field defined for contacts (null when unset). The value's shape follows the field's type.