Skip to main content
GET
List contacts

Endpoint

Route: /contacts
Authentication: Bearer JWT

Query parameters

Default response fields

When properties is omitted, each item in data includes:
created_at and updated_at are always included in every response (ISO 8601 UTC), even when not listed above. When an object is archived, archived_by is also included automatically.

Response

200 — Paginated list

Errors

Authorizations

Authorization
string
header
required

Bearer JWT with valid account context.

Query Parameters

properties
string

Comma-separated additional property names to include alongside defaults (e.g. phone). Invalid or disallowed names return 400.

archived
boolean

Include archived objects when true

limit
integer
default:10

Maximum results (default 10, max 100)

Required range: 1 <= x <= 100
offset
integer
default:0

Pagination offset (default 0)

Required range: x >= 0

Response

Paginated list

data
object[]
pagination
object