Skip to main content
POST
Paginate Message
Use this endpoint for team-wide message exports, sync jobs, and analytics pipelines that need to walk through message history.
Sending an empty JSON body returns the most recent messages. To continue pagination, pass the last returned message timestamp as created_at in the next request.

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

Message pagination json

created_at
string<date-time>
required

Last returned message timestamp. Fetch messages created on and after this RFC 3339 timestamp.

ascending
boolean

True to sort in ascending order. Defaults to descending.

inbox_id
integer

Optional inbox ID to filter messages.

limit
integer

Messages to return per page. Defaults to 30.

order
string

Field to sort by. Valid values are created_at and updated_at.

Response

array of messages in team

author
string
broadcast_id
integer
conversation
object
custom
object
date
string
flagged
boolean
id
integer
local_id
string
media
string
phone
string
status
string
super
integer
support
boolean
target
string
text
string
type
string
updated
string
user
integer