Skip to main content
GET
List or look up contacts

Authorizations

Authorization
string
header
required

Workspace API key, e.g. Authorization: Bearer tented_.... Create keys in Workspace Settings → API Keys.

Query Parameters

email
string

Lookup mode: return the contact whose normalized email matches. Supplying this (non-empty) switches the endpoint to lookup mode and listing parameters are ignored.

phone
string

Lookup mode: return the contact whose normalized phone matches. Consulted after email when both are given. Supplying this (non-empty) switches the endpoint to lookup mode.

page
integer
default:1

Listing mode: page number, starting at 1.

Required range: x >= 1
limit
integer
default:25

Listing mode: results per page (1–100).

Required range: 1 <= x <= 100
sort
enum<string>
default:updated_at

Listing mode: sort key.

Available options:
created_at,
updated_at,
last_activity_at,
display_name,
first_name,
last_name,
normalized_email,
original_source
order
enum<string>
default:desc

Listing mode: sort direction.

Available options:
asc,
desc

Listing mode: case-insensitive substring match against display name, email, phone, company, first name, and last name.

Maximum string length: 255
updated_after
string<date-time>

Listing mode: only return contacts updated strictly after this ISO 8601 timestamp.

Response

Matching contacts. Lookup mode returns 0 or 1 items (with custom_fields) and no pagination; listing mode returns a page of contacts (without custom_fields) plus pagination.

items
object[]
required

Contacts. In lookup mode, at most one item, including custom_fields. In listing mode, the current page, without custom_fields.

pagination
object

Present in listing mode only.