API reference · Dashboard

List contacts

One row per person, deduplicated across sessions and devices - unlike /conversations, which is one row per session.

gethttps://api.integrable.cloud/api/bots/{bot_id}/contacts

Authentication: Bearer token
Retries: Safe to repeat
Body: None
Version: 2026-09-03

Path parameters

bot_idstringrequired

Query parameters

pageinteger
Default: 1·≥ 1
page_sizeinteger
Default: 20·≥ 1 and ≤ 100
qstring | null
Up to 200 characters
leads_onlyboolean
Default: true
sortstring | null
Up to 64 characters
cursorstring | null
Up to 512 characters
countboolean
Default: true

Responses

200OKapplication/json
PaginatedResponse_ContactRead_
- itemsarray of ContactReadrequired
  13 fields · ContactRead
  first_seen_atstring (date-time)required
  idstringrequired
  last_seen_atstring (date-time)required
  visitor_idstringrequired
  conversation_countinteger
  Default: 0
  countrystring | null
  custom_fieldsobject
  emailstring | null
  is_leadboolean
  Default: false
  message_countinteger
  Default: 0
  namestring | null
  phonestring | null
  tagsarray of any
- pageintegerrequired
- page_sizeintegerrequired
- totalintegerrequired
- has_moreboolean
  Default: false
- next_cursorstring | null
5 response headers
RateLimit-Limit
Requests permitted in the current window.
RateLimit-Remaining
Requests left in the current window. Back off before it reaches 0.
RateLimit-Reset
Seconds until the current window resets.
X-API-Version
The dated version of the API contract that served this response, e.g. 2026-09-03. Pin against it; it changes only when a response shape changes incompatibly.
X-Request-ID
Quote this in a support request to identify the call.
422Validation error
The shared error envelope, served as application/problem+json with error.code set to validation_error. Its details name each field that failed and why.

Example request

curl

curl "https://api.integrable.cloud/api/bots/$BOT_ID/contacts" \
  -H "Authorization: Bearer $INTEGRABLE_API_KEY"

Set INTEGRABLE_API_KEY and the path variables first. The same call from the TypeScript or Python SDK takes the same fields.

Example response

200 OK · application/json

{
  "has_more": false,
  "items": [
    {
      "conversation_count": 0,
      "country": "string",
      "custom_fields": {},
      "email": "sam@example.com",
      "first_seen_at": "2026-09-03T09:30:00Z",
      "id": "01a0652b-3713-7ea1-a6c9-2e895389ec34",
      "is_lead": false,
      "last_seen_at": "2026-09-03T09:30:00Z",
      "message_count": 0,
      "name": "string",
      "phone": "+15550100",
      "tags": [
        "string"
      ],
      "visitor_id": "01a0652b-3713-7ea1-a6c9-2e895389ec34"
    }
  ],
  "next_cursor": "string",
  "page": 0,
  "page_size": 20,
  "total": 0
}

Generated from the schema above — the shape is exact, the values are placeholders.

Errors

Failures use one envelope on every endpoint, described in Retries, versioning and limits. The codes you are most likely to meet here:

validation_error · 422 — The payload was well-formed JSON but failed schema validation.
unauthenticated · 401 — The request carried no API key, or one the API could not verify.
forbidden · 403 — The key is valid, but it is not allowed to do this — either the scope is missing or the resource belongs to another workspace.
rate_limited · 429 — Too many requests in the current window. The limit is per workspace, and some endpoints add a per-bot limit on top.

More Dashboard endpoints

Something here wrong or missing? Tell us — the documentation and the API are maintained by the same person, so a correction is a fix rather than a ticket.