Skip to main content
POST
Paginate Links

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

Link pagination json. All attributes are optional; an empty body returns the first page.

page
integer

Page number to fetch.

limit
integer
default:20

Links per page. Values above 100 are rejected with 400.

Required range: 1 <= x <= 100
order
enum<string>
default:desc

Sort order by creation date.

Available options:
asc,
desc

Response

Page of Links in team

total
integer

Total number of links for the team.

page
integer

Page returned.

limit
integer

Page size used.