Skip to main content
GET
List client contacts

Authorizations

Authorization
string
header
required

Authenticate with a Bearer token: API key, OAuth token, or session token.

Query Parameters

offset
integer | null
default:0

Records to skip for pagination. Defaults to 0.

Required range: x >= 0
limit
integer
default:100

Max records per page (1–100). Defaults to 100.

Required range: 1 <= x <= 100
person_id
string<uuid>

Return only the client contact linked to this person UUID.

client_id
string<uuid>

Return only client contacts linked to this client company UUID.

client_contact_status_id
string<uuid>

Return only client contacts with this status UUID. Use GET /v1/client-contacts/statuses to discover status IDs.

sort_by
enum<string>
default:created_at

Column to sort results by. Defaults to created_at.

  • created_at — when the client contact was created
  • updated_at — when the client contact was last updated
Available options:
created_at,
updated_at
sort_order
enum<string>
default:desc

Sort direction. Defaults to desc (newest first).

Available options:
asc,
desc

Response

Client contacts fetched

success
enum<boolean>
required
Available options:
true
data
object[]
required
meta
object
required