PAparley
Contacts

List contacts

List contacts (people, each optionally belonging to one account), newest first by default. Filter by name or email, account, linked project, and when contacts were created or updated.

get/contacts

Request

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

Query parameters

searchstring

Case-insensitive. Every word must match the first name, last name, account name, an email address, or a text custom field.

emailstring

Only the contact with exactly this email address.

accountIdstring

Only contacts belonging to this account.

hasAccountboolean

true for contacts that belong to an account, false for contacts that do not.

projectIdstring

Only contacts linked to this project.

createdSincestring

Only records created at or after this time. An ISO 8601 date (YYYY-MM-DD, read as UTC midnight) or date-time.

createdBeforestring

Only records created before this time. An ISO 8601 date (YYYY-MM-DD, read as UTC midnight) or date-time.

updatedSincestring

Only records last updated at or after this time. An ISO 8601 date (YYYY-MM-DD, read as UTC midnight) or date-time.

updatedBeforestring

Only records last updated before this time. An ISO 8601 date (YYYY-MM-DD, read as UTC midnight) or date-time.

sort'name' | '-name' | 'createdAt' | '-createdAt' | 'updatedAt' | '-updatedAt'

Sort order: a field name, prefixed with - for descending. name sorts by first name, then last name. Defaults to -createdAt.

cursorstring

Opaque cursor from nextCursor. Pass the same filters and sort. Omit for the first page.

limitinteger

Maximum number of items to return.

Response

OK

nextCursorstring nullable required

Cursor for the next page, or null on the last page.

Example response

{
  "data": [
    {
      "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.