List contacts

GET

/api/v1/contacts

Authorizations

• bearerAuth

Parameters

Query Parameters

after

Opaque cursor: pass the next_cursor of the previous page back unchanged. With sort it must come from a page with the same sort and order; without sort it is the id of the last record.

string

Opaque cursor: pass the next_cursor of the previous page back unchanged. With sort it must come from a page with the same sort and order; without sort it is the id of the last record.

limit

integer

>= 1 <= 200

company_id

string format: uuid

tag_id

string format: uuid

contacted_since

Only contacts last contacted at or after this ISO-8601 time (Z or an offset). Needs interactions:read.

string format: date-time

Only contacts last contacted at or after this ISO-8601 time (Z or an offset). Needs interactions:read.

not_contacted_since

Only contacts last contacted before this ISO-8601 time (Z or an offset), including those never last. Needs interactions:read.

string format: date-time

Only contacts last contacted before this ISO-8601 time (Z or an offset), including those never last. Needs interactions:read.

never_contacted

True: only contacts never contacted; false: only contacts contacted at least once. Needs interactions:read.

string

Allowed values: true false

True: only contacts never contacted; false: only contacts contacted at least once. Needs interactions:read.

interacted_since

Only contacts last interacted with at or after this ISO-8601 time (Z or an offset). Needs interactions:read.

string format: date-time

Only contacts last interacted with at or after this ISO-8601 time (Z or an offset). Needs interactions:read.

not_interacted_since

Only contacts last interacted with before this ISO-8601 time (Z or an offset), including those never last interacted with. Needs interactions:read.

string format: date-time

Only contacts last interacted with before this ISO-8601 time (Z or an offset), including those never last interacted with. Needs interactions:read.

never_interacted

True: only contacts never interacted with; false: only contacts interacted with at least once. Needs interactions:read.

string

Allowed values: true false

True: only contacts never interacted with; false: only contacts interacted with at least once. Needs interactions:read.

sort

Sort by id or created_at or updated_at or name or last_contacted_at or last_interacted_at. Stored columns need only this list’s read scope; derived fields need the scopes that show them. null sorts as the lowest value: first in asc, last in desc. Ties break on id in the same direction. Newest first: sort=created_at&order=desc; for mail use sort=occurred_at&order=desc. Without sort the list is in ascending id order with UUID cursors. Paging is by keyset, not a snapshot: values can rise between pages (or fall), so a record may repeat in asc or be missed in desc. In descending mail date order, newly arrived mail ahead of the cursor is not seen; backfilled older mail behind it is. A complete walk uses the default order. An incremental walk also uses the default ascending id order. Mail created_at uses a temporary sort over the workspace’s rows; id is indexed and follows capture order.

string

Allowed values: id created_at updated_at name last_contacted_at last_interacted_at

Sort by id or created_at or updated_at or name or last_contacted_at or last_interacted_at. Stored columns need only this list’s read scope; derived fields need the scopes that show them. null sorts as the lowest value: first in asc, last in desc. Ties break on id in the same direction. Newest first: sort=created_at&order=desc; for mail use sort=occurred_at&order=desc. Without sort the list is in ascending id order with UUID cursors. Paging is by keyset, not a snapshot: values can rise between pages (or fall), so a record may repeat in asc or be missed in desc. In descending mail date order, newly arrived mail ahead of the cursor is not seen; backfilled older mail behind it is. A complete walk uses the default order. An incremental walk also uses the default ascending id order. Mail created_at uses a temporary sort over the workspace’s rows; id is indexed and follows capture order.

order

Sort direction: asc (default) or desc. Needs sort.

string

Allowed values: asc desc

Sort direction: asc (default) or desc. Needs sort.

Responses

200

Success

object

data

required

Array<object>

object

id

required

string format: uuid

organization_id

required

string format: uuid

name

required

string | null

company_id

required

string | null format: uuid

merged_into_id

required

string | null format: uuid

created_by

required

string format: uuid

created_at

required

string

updated_at

required

string

last_contacted_at

When the latest outbound interaction with any of the contact’s identities happened; null if none. Derived, read-only; present only with interactions:read.

string | null

last_interacted_at

When the latest interaction, in either direction, with any of the contact’s identities happened; null if none. Derived, read-only; present only with interactions:read.

string | null

next_cursor

required

Opaque cursor for the next page, or null at the end. Pass it back as after, with the same sort and order.

string | null