PAparley
Contacts

Get a contact

Get a single contact (person) by ID.

get/contacts/{id}

Request

  • Base URL
    https://api.parley.so/v1
  • URL
    https://api.parley.so/v1/contacts/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

The contact ID.

Response

OK

idstring required

The contact ID.

firstNamestring required

First name. Empty for some contacts created from email.

lastNamestring required

Last name. Empty for some contacts created from email.

emailsstring[] required

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

projectCountinteger 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.

createdAtstring date-time required

When the contact was created.

updatedAtstring 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.

fieldsobject 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.

Example response

{
  "id": "cmf2x7z3e0002abcd",
  "firstName": "Ada",
  "lastName": "Lovelace",
  "emails": [
    "ada@acme.example"
  ],
  "account": {
    "type": "account",
    "id": "cmf2x7r1p0000abcd",
    "name": "Acme Corp"
  },
  "projectCount": 1,
  "createdAt": "2026-09-12T10:05:00.000Z",
  "updatedAt": "2026-09-12T10:05:00.000Z",
  "fields": {
    "Contact Type": "Beneficiary",
    "Country of Birth": "United Kingdom"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.