Paginate lists (v1)
Paginate lists with the legacy v1 cursor-based endpoint.
curl --request POST \
--url https://api.heymarket.com/v1/lists \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"archived": true,
"ascending": true,
"assigned": 123,
"date": "<string>",
"filter": "<string>",
"filters": {},
"id": 123,
"limit": 123,
"order": "<string>",
"page": 123,
"parent_id": 123
}
'import requests
url = "https://api.heymarket.com/v1/lists"
payload = {
"archived": True,
"ascending": True,
"assigned": 123,
"date": "<string>",
"filter": "<string>",
"filters": {},
"id": 123,
"limit": 123,
"order": "<string>",
"page": 123,
"parent_id": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
archived: true,
ascending: true,
assigned: 123,
date: '<string>',
filter: '<string>',
filters: {},
id: 123,
limit: 123,
order: '<string>',
page: 123,
parent_id: 123
})
};
fetch('https://api.heymarket.com/v1/lists', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.heymarket.com/v1/lists",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'archived' => true,
'ascending' => true,
'assigned' => 123,
'date' => '<string>',
'filter' => '<string>',
'filters' => [
],
'id' => 123,
'limit' => 123,
'order' => '<string>',
'page' => 123,
'parent_id' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.heymarket.com/v1/lists"
payload := strings.NewReader("{\n \"archived\": true,\n \"ascending\": true,\n \"assigned\": 123,\n \"date\": \"<string>\",\n \"filter\": \"<string>\",\n \"filters\": {},\n \"id\": 123,\n \"limit\": 123,\n \"order\": \"<string>\",\n \"page\": 123,\n \"parent_id\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.heymarket.com/v1/lists")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"archived\": true,\n \"ascending\": true,\n \"assigned\": 123,\n \"date\": \"<string>\",\n \"filter\": \"<string>\",\n \"filters\": {},\n \"id\": 123,\n \"limit\": 123,\n \"order\": \"<string>\",\n \"page\": 123,\n \"parent_id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heymarket.com/v1/lists")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"archived\": true,\n \"ascending\": true,\n \"assigned\": 123,\n \"date\": \"<string>\",\n \"filter\": \"<string>\",\n \"filters\": {},\n \"id\": 123,\n \"limit\": 123,\n \"order\": \"<string>\",\n \"page\": 123,\n \"parent_id\": 123\n}"
response = http.request(request)
puts response.read_body[
{
"archived": true,
"created": "<string>",
"creator_id": 123,
"id": 123,
"local_id": "<string>",
"name": "<string>",
"op": "<string>",
"rev": 123,
"shared": true,
"targets": {},
"team_id": 123,
"updated": "<string>"
}
]"<string>"Unauthorizedtoo many requestserrorPOST /v2/lists/paginate takes the same request body and returns the same response shape.Filter by list ID
Usefilters, not filter, to filter list pagination results. The only supported list pagination filter is id.
{
"filters": {
"id": [21152]
}
}
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
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:
{ "alg": "HS256", "typ": "JWT" }
{ "iss": "YOUR_API_SECRET_ID", "iat": CURRENT_UNIX_TIMESTAMP }
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:
YOUR_API_SECRET_ID||YOUR_API_SECRET_KEY
Send the signed JWT as a bearer token:
Authorization: Bearer YOUR_SIGNED_JWT
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
Pagination json
Was this page helpful?
curl --request POST \
--url https://api.heymarket.com/v1/lists \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"archived": true,
"ascending": true,
"assigned": 123,
"date": "<string>",
"filter": "<string>",
"filters": {},
"id": 123,
"limit": 123,
"order": "<string>",
"page": 123,
"parent_id": 123
}
'import requests
url = "https://api.heymarket.com/v1/lists"
payload = {
"archived": True,
"ascending": True,
"assigned": 123,
"date": "<string>",
"filter": "<string>",
"filters": {},
"id": 123,
"limit": 123,
"order": "<string>",
"page": 123,
"parent_id": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
archived: true,
ascending: true,
assigned: 123,
date: '<string>',
filter: '<string>',
filters: {},
id: 123,
limit: 123,
order: '<string>',
page: 123,
parent_id: 123
})
};
fetch('https://api.heymarket.com/v1/lists', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.heymarket.com/v1/lists",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'archived' => true,
'ascending' => true,
'assigned' => 123,
'date' => '<string>',
'filter' => '<string>',
'filters' => [
],
'id' => 123,
'limit' => 123,
'order' => '<string>',
'page' => 123,
'parent_id' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.heymarket.com/v1/lists"
payload := strings.NewReader("{\n \"archived\": true,\n \"ascending\": true,\n \"assigned\": 123,\n \"date\": \"<string>\",\n \"filter\": \"<string>\",\n \"filters\": {},\n \"id\": 123,\n \"limit\": 123,\n \"order\": \"<string>\",\n \"page\": 123,\n \"parent_id\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.heymarket.com/v1/lists")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"archived\": true,\n \"ascending\": true,\n \"assigned\": 123,\n \"date\": \"<string>\",\n \"filter\": \"<string>\",\n \"filters\": {},\n \"id\": 123,\n \"limit\": 123,\n \"order\": \"<string>\",\n \"page\": 123,\n \"parent_id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heymarket.com/v1/lists")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"archived\": true,\n \"ascending\": true,\n \"assigned\": 123,\n \"date\": \"<string>\",\n \"filter\": \"<string>\",\n \"filters\": {},\n \"id\": 123,\n \"limit\": 123,\n \"order\": \"<string>\",\n \"page\": 123,\n \"parent_id\": 123\n}"
response = http.request(request)
puts response.read_body[
{
"archived": true,
"created": "<string>",
"creator_id": 123,
"id": 123,
"local_id": "<string>",
"name": "<string>",
"op": "<string>",
"rev": 123,
"shared": true,
"targets": {},
"team_id": 123,
"updated": "<string>"
}
]"<string>"Unauthorizedtoo many requestserror