Skip to main content
POST
Paginate Conversations
Use this endpoint to list conversations by inbox, closed state, unread state, and pagination cursor.

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 Conversations in team

assigned
integer
blocked
boolean
channel
string
created
string
creator
integer
email_noti
boolean
id
integer
inbox
integer
last_inbound
integer
local_id
string
members
object[]
muted
boolean
name
string
noreply
string
op
string
read
integer
replied
boolean
snooze_till
string
status
string
super
integer
support
boolean
target
string
type
string
updated
string