Skip to content
Language: English

API for developers

API keys, endpoints, rate limits and webhooks

9 articles

The LinkHarbor API at a glance

Base URL, sandbox, versioning, data format, pagination and authentication: what to know before your first LinkHarbor REST API call.

API keys and access tokens

Create an API key in the dashboard, choose scopes, exchange it for a 15-minute token, store it safely and revoke it when needed – step by step.

Scopes: every API permission

All 15 scopes for API keys and AI connections: what each scope allows, what it is called in the dashboard and what no API key can do.

API endpoints by area

Every endpoint you can use with an API key – sorted by area, with the method, path, required scope and what it does.

Rate limits: every limit and header

How many requests per minute the LinkHarbor API allows, how large a request may be, how to read the headers and how to handle a 429 properly.

API error format and error codes

How LinkHarbor API error responses are structured, what the most important error codes mean and how your code should react to them.

Webhooks: events, payload and signature

Set up webhooks in the dashboard, receive deliveries and verify the HMAC signature – with examples for curl, Node.js and PHP.

Send sales and your own data to LinkHarbor

Use sale callbacks to match sales from your shop to link clicks, and “Custom (API)” to send live data from your own tools to your page.

Step by step: update a page via the API

From API key to published version: add a link, move it to the top, change the design, validate the draft and publish – with curl and jq.