Get a legacy contact

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 one contact, migrated or not; a migrated contact names its customer or vendor in successor. Requires the contacts:read OAuth scope.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Query Params
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.

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
*/*