v1

latestOpenAPI 3.1.02026-07-26167644759.4 KB

Client Contacts

Get client contacts

Returns a list of client contacts. Uses cursor pagination.

get/clients/contacts

Query parameters

limitinteger

Example:25

Number of client contacts to return per page (min: 1, max: 50, default: 25).

cursorstring

Example:eyJtb2RpZmllZEF0IjoiMjAyNC0xMS0wNlQxMDozMDowMC4wMDBaIiwiaWQiOiJjbGllbnQtY29udGFjdC0xMjMifQ.signature

Opaque cursor string for pagination. Use the cursor value from a previous response to fetch the next page. Omit for the first page.

modifiedSincestring date-time

Filter client contacts by sync watermark on or after this date. Useful for incremental synchronization. Defaults to beginning of time if not provided.

modifiedUntilstring date-time

Filter client contacts by sync watermark on or before this date. Useful for bounded synchronization snapshots. If omitted, no upper bound is applied.

listIdsstring[]

Filter client contacts by client contact list IDs.

[
  "client-contact-list-123",
  "client-contact-list-456"
]

client_idsstring[]

Filter client contacts by client IDs.

[
  "client-123",
  "client-456"
]

Response

Successfully retrieved client contacts. Returns items with pagination metadata containing the cursor for the next page.