List contacts
Returns the project's contacts sorted by displayName (ties broken by id), one keyset page at a time.
Returns the project's contacts sorted by displayName (ties broken by id), one keyset page at a time. The list view is a lightweight projection — each contact carries its core fields but not its handles; fetch a single contact to get those. Page with limit (1–100, default 50) and the opaque cursor: pass pagination.nextCursor back as cursor while pagination.hasMore is true. Only cursors Dairo issued are accepted, and any other query parameter returns 400. Requires the contacts:read scope.
Scope: contacts:read. Send the API key as a bearer token; Scopes lists what each one reaches.
Request
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | no | Maximum number of items in the page. (minimum 1, maximum 100, default 50) |
cursor | string | no | The nextCursor of the previous page; omit it for the first page (Pagination). |
Response
200 Success. Body: application/json, ContactListResponse.
| Field | Type | Required | Description |
|---|---|---|---|
object | "list" | yes | |
data | array of Contact | yes | |
pagination | Pagination | 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). |