Skip to main content
POST
Paginate Contact
Use this endpoint to retrieve contacts page by page.

Authorizations

Authorization
string
header
required

Recommended authentication for new integrations. Generate a short-lived JWT from your API Secret ID and API Secret Key, then pass the signed JWT as a bearer token in the Authorization header.

API Secret credentials are available in the Heymarket app under Settings > Integrations > API. The Secret Key is shown only when it is generated, so copy and store it securely before closing the dialog.

Use the following JWT values:

Replace CURRENT_UNIX_TIMESTAMP with the current Unix timestamp in seconds when generating the token.

Sign the JWT with HMAC-SHA256 using this signing secret:

Send the signed JWT as a bearer token:

Tokens expire 5 minutes after the iat timestamp. Generate a new JWT per request, or cache it briefly for less than 5 minutes. Generate JWTs only from trusted server-side code; do not expose the API Secret Key in browser, mobile, or other client-side code.

Body

application/json

Pagination json

archived
boolean
ascending
boolean
assigned
integer
date
string
filter
string
filters
object

Object-specific filters. For conversations this supports fields such as inboxes, closed, unread, ids, and unanswered.

id
integer
limit
integer
order
string
page
integer
parent_id
integer

Response

array of Contacts in team

avatar
string
created
string
creator_id
integer
custom
object
display_name
string
email
string
external_id
string
external_ref
string
first
string
id
integer
inbox_id
integer
last
string
note
object[]
op
string
parent_id
integer
phone
string
rev
integer
shared
boolean
team_id
integer
type
string
updated
string
assigned_user_id
integer
tags
any[]