Skip to main content
POST
Paginate Lists
Use this endpoint to retrieve lists page by page. This endpoint is deprecated, but it is currently the only endpoint for paginating lists.
There is no v2 replacement for list pagination. Use /v2/lists for v2 create, update, and delete operations.

Filter by list ID

Use filters, not filter, to filter list pagination results. The only supported list pagination filter is id.
filters.id accepts an array of list IDs. A single ID matches that list. Multiple IDs return lists whose id is in the array. The legacy filter string field is ignored by this endpoint.

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 List objects in a team

archived
boolean
created
string
creator_id
integer
id
integer
local_id
string
name
string
op
string
rev
integer
shared
boolean
targets
object
team_id
integer
updated
string