API reference
GETRequires Bearer token
List contacts
/api/contacts
Address book for the caller. scope is mine, org, or all (default). Emails and phones are normalized. Returns a ContactOut[] array (id, owner_user_id, org_id, visibility, names, email, phone, title, company, source, source_uid, extra, timestamps).
Path parameters
This endpoint has no path parameters.
Query parameters
| Field | Type | Description |
|---|---|---|
q | string | Search name, email, or company. e.g. "ada" |
source | string | Filter by source: manual, csv, ldap, google, outlook.e.g. "csv" |
visibility | string | private or org.e.g. "private" |
scope | string | mine, org, or all (default).e.g. "all" |
limit | integer | Page size (1–200, default 50). e.g. 50 |
offset | integer | Offset (default 0). e.g. 0 |
Request body
This endpoint does not accept a request body.
Responses
| Status | Meaning |
|---|---|
| 200 | Contacts |
| 401 | Missing or invalid Bearer token. |