List contacts
The workspace’s contacts (the same list the console shows), filtered and sorted.
ApiKeyAuthorizationBearer <token>An API key from Developers → API keys: Authorization: Bearer gauge_live_… (or pulse_k_live_…).
limit?stringPage size, 1–100 (default 25).
after?stringA nextCursor from the previous page. Opaque.
before?stringA prevCursor, to page back. Opaque. Not with after.
q?stringName, email, phone or company contains (case-insensitive).
email?stringExact email.
phone?stringPhone, any format (matched on digits).
tag?stringContacts with this tag.
company?stringCompany name contains.
updatedSince?stringISO-8601. Changed at or after.
createdSince?stringISO-8601. Created at or after.
channel?stringWith externalId: the contact holding this channel identity. Alone: contacts with any identity on it.
externalId?stringThe identity on channel (a phone, a WhatsApp id, an email…).
sort?stringDefault -createdAt (newest first).
"createdAt""-createdAt""updatedAt""-updatedAt"Gauge-Version?stringA dated version. Default 2026-10-21.
A page of contacts.
application/json- response
A cursor page over (created_at, id). Every list returns this shape.
data*array<>nextCursor*|Pass as after for the next page; null on the last page.
prevCursor*|Pass as before for the previous page; null on the first page.
curl -X GET 'https://app.gauge.chat/api/v2/contacts'{ "nextCursor": "string", "prevCursor": "string", "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "displayName": "string", "email": "string", "phone": "string", "title": "string", "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda", "companyName": "string", "lifecycleStage": "string", "isVip": true, "tags": [ "string" ], "customFields": { "property1": null, "property2": null }, "identities": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "channel": "string", "externalId": "string", "connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d" } ], "createdAt": "string", "updatedAt": "string" } ]}