API referenceContacts
Get a contact with its handles
Returns one contact by id along with its full handles array, ordered primary handles first and then oldest to newest.
Returns one contact by id along with its full handles array, ordered primary handles first and then oldest to newest. contactId is the contact's UUID. Returns 404 for an unknown contact or one owned by another project. Requires the contacts:read scope.
Scope: contacts:read. Send the API key as a bearer token; Scopes lists what each one reaches.
Request
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
contactId | string | yes | The contact's ID. |
Response
200 Success. Body: application/json, ContactDetailResponse.
| Field | Type | Required | Description |
|---|---|---|---|
contact | Contact | yes |
Errors
Every error has the same body, {"error": {"type", "code", "message", "param"}}; branch on code. Errors lists every code.
| Status | Meaning |
|---|---|
400 | The request is malformed or a value is invalid (invalid_request, invalid_domain, idempotency_key_mismatch). |
401 | The API key is missing or invalid. |
403 | The key lacks the scope this endpoint needs (scope_missing) or may not do this (not_permitted). |
404 | No such resource in this account (resource_not_found). |
422 | The request is well-formed but a field failed validation (validation_failed). |
429 | Rate limit, plan limit, budget or spend cap reached (rate_limited, plan_limit_reached, budget_exceeded, spend_cap_reached). |
500 | An unexpected error; retry with backoff, then contact support (internal_error). |