List legacy contacts

Deprecated — sunset 2027-03-31. Use /customers and /vendors.

A contact is the LEGACY unified party record (a person or an organisation) from before customers and vendors became separate resources; a 2024 migration moved the contacts that existed then into customers and vendors, recorded as migrated_customer_id / migrated_vendor_id and exposed as successor. New integrations should use /customers and /vendors instead. Returns contacts of the credential-bound company using cursor pagination. By default only contacts NOT migrated are returned, which includes every contact created since the migration (filter[migration_status]=active); pass migrated or all to include the migrated ones. Requires the contacts:read OAuth scope.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Opaque cursor returned by the preceding collection response.

integer
1 to 100
Defaults to 25

Number of resources per cursor page.

string
^-?(?:created_at|updated_at|id)(?:,-?(?:created_at|updated_at|id))*$
Defaults to -updated_at,-id

Comma-separated allowlisted sort fields; prefix descending fields with a minus sign.

string
^(?:person|organisation|addresses|tags|custom_fields)(?:,(?:person|organisation|addresses|tags|custom_fields))*$

Comma-separated allowlisted relationships.

string
^(?:id|kind|customer_number|legal_name|debtor_creditor_number|description|phone|email|web|currency_id|person|organisation|addresses|tags|custom_fields|source_ids|successor|version|created_at|updated_at)(?:,(?:id|kind|customer_number|legal_name|debtor_creditor_number|description|phone|email|web|currency_id|person|organisation|addresses|tags|custom_fields|source_ids|successor|version|created_at|updated_at))*$

Comma-separated sparse response fields. The id field is always retained.

uuid
string
enum
Allowed:
date-time
string
enum
Allowed:
Responses

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*