Help Centre

Using the API

The API is included with Pro and Bulk. Workspace admins create keys under API in the app. Keys are shown once, so store them safely, and revoke any key you no longer use.

Authentication

Authorization: Bearer olk_your_key_here

Create a link

curl -X POST https://orbislink.co.uk/api/v1/links \
  -H "Authorization: Bearer olk_..." \
  -H "Content-Type: application/json" \
  -d '{"destination":"https://example.co.uk/page","code":"page","tags":["web"]}'

Other endpoints

GET    /api/v1/links?page=1&limit=50&tag=web
GET    /api/v1/links/{id}
PATCH  /api/v1/links/{id}
DELETE /api/v1/links/{id}
GET    /api/v1/links/{id}/stats?days=30

Responses are JSON. Errors use HTTP status codes (401, 402, 404, 422, 429) with a message. Each key can make 600 requests a minute. Full details are in the API documentation inside the app.

More help

Still stuck? Contact our UK team.