Skip to main content
GET
List contacts

Authorizations

Authorization
string
header
required

Your workspace API key, created in Settings → API keys, sent as Authorization: Bearer <key>. New keys start with watx_live_; keys issued before the rename start with converse360_live_ and still work.

Query Parameters

limit
integer
default:50

Page size. Default 50, maximum 100. An unusable value falls back to 50.

Required range: 1 <= x <= 100
cursor
string

The meta.next_cursor from the previous page, passed back verbatim. An unreadable cursor is ignored and the first page is returned.

Matches the contact's name or phone number, case-insensitively. Characters other than letters, digits, space and + @ . - _ are stripped before the search runs.

tag
string<uuid>

Return only contacts carrying this tag id.

Response

A page of contacts.

data
object[]
meta
object

Pagination metadata on list responses.