List Contacts

List the authenticated user's CRM contacts with search, filtering, and pagination. Requires an OAuth access token with 'contacts' scope.

GET/v1/contacts

Authentication

OAuthAuthorization: Bearer

Requires OAuth access token (scope: contacts)

Query Parameters

querystring
optional

Search by name, email, or phone

pagenumber
optional

Page number (default: 1)

limitnumber
optional

Results per page (max 50, default: 25)

sinceISO 8601
optional

Contacts created/updated after this time

stagestring
optional

Filter by pipeline stage

tagstring
optional

Filter by tag

Sortenum
optional

Sort field

Default:createdAt
createdAtlastActivityDatename
Orderenum
optional

Sort order

Default:desc
descasc

Responses

200Success
application/json
totalnumber

Total matching contacts

pagenumber

Current page number

limitnumber

Results per page

contactsarray

Array of contact objects

Retrieve the right contact set

Call this endpoint with an OAuth token that has the contacts scope. The query parameter searches contact names, email addresses or phone numbers. Start with a small result set when validating a connection, and confirm that the returned contacts belong to the expected application. Use Get Current User first if the account context is unclear.

Page through results

Use page and limit to control the result window. Keep the same search and sort settings as you move through pages so your application presents a consistent view. Respect the parameter names and capitalization shown in the reference. Review the pagination information returned by the API before requesting additional pages; an empty result set can simply mean that no contact matches the current query.

Connect list and detail views

Use a contact ID from the results when requesting an individual contact or its separate activity feed. Fetch detailed activity when a user needs it instead of loading every feed for the whole contact list. Keep contact exports and diagnostic data private. If your application caches results, identify the connected account alongside the cached data to avoid mixing records from different websites.

OAuth authorization · Check the connected account · API setup guide