v3

OpenAPI 3.1.02026-07-2759128137.8 KB
contacts

List Contacts

List contacts attached to the authenticated organization.

Requires the contacts:read scope on the API key.

get/v1/contacts

Query parameters

pageinteger

Page number.

Page number.

sizeinteger

Number of items per page.

Number of items per page.

sort_by'first_seen_at' | 'last_seen_at' | 'email'

Field to sort by.

sort_order'asc' | 'desc'

Sort direction.

emailstring nullable

Filter by email (case-insensitive exact match).

Filter by email (case-insensitive exact match).

linkedin_urlstring nullable

Filter by LinkedIn profile URL. Matched against all known canonical variants (trailing slash, www. prefix, etc.).

Filter by LinkedIn profile URL. Matched against all known canonical variants (trailing slash, www. prefix, etc.).

contact_idstring uuid nullable

Filter by contact ID.

Filter by contact ID.

first_seen_afterstring date-time nullable

Return contacts first seen strictly after this timestamp.

Return contacts first seen strictly after this timestamp.

last_seen_afterstring date-time nullable

Return contacts last seen strictly after this timestamp.

Return contacts last seen strictly after this timestamp.

Response

Successful Response

total_countinteger required

Total number of records matching the query.

total_pagesinteger required

Total number of pages.

has_moreboolean required

Whether more pages remain after the current one.