Skip to main content
GET
List contacts

Authorizations

Authorization
string
header
required

A Parley API key.

Query Parameters

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

Minimum string length: 1
email
string

Only the contact with exactly this email address.

Minimum string length: 1
accountId
string

Only contacts belonging to this account.

Minimum string length: 1
hasAccount
boolean

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

projectId
string

Only contacts linked to this project.

Minimum string length: 1
createdSince
string

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

createdBefore
string

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

updatedSince
string

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

updatedBefore
string

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

sort
enum<string>
default:-createdAt

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

Available options:
name,
-name,
createdAt,
-createdAt,
updatedAt,
-updatedAt
cursor
string

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

Minimum string length: 1
limit
integer
default:50

Maximum number of items to return.

Required range: 1 <= x <= 250

Response

OK

data
object[]
required
nextCursor
string | null
required

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