Skip to main content
GET
List contacts
Returns saved contacts from the workspace connected to your API key. Scan drafts appear only after someone saves them.

Choose the order

For example, use /contacts?sort=updatedAt&limit=25&offset=0 to review updated contacts.
sort=updatedAt leaves out contacts that have never been updated. Use createdAt when you need the full contact list.

Read more contacts

Each response includes data and pagination. Use limit and offset to fetch the next page while pagination.hasMore is true. Pagination example The response includes contact details, tags, submitted messages, internal notes, and the assigned team member. updatedAt is null until a contact has been updated.

Authorizations

Authorization
string
header
required

API key created under Settings → API keys.

Query Parameters

limit
integer
default:100

Maximum items per page. Values are clamped to 1–100; missing or invalid numbers default to 100.

Required range: 1 <= x <= 100
offset
integer
default:0

Items to skip before this page. Negative values become 0; missing or invalid numbers default to 0.

Required range: x >= 0
sort
enum<string>
default:createdAt

createdAt returns all saved contacts. updatedAt returns only contacts with a non-null updatedAt. Both sort newest first.

Available options:
createdAt,
updatedAt

Response

A paginated list of contacts

data
object[]
required
pagination
object
required

Information for moving through a list of results.