Skip to content

Link Developer API · v1

Connect real Link data to your product.

Scoped live keys, targeting with the route graph, QR and analytics. The reference is public; keys, usage and the tester live in the signed-in console.

Create key Quickstart

Only bk_live_* keys · ownership comes from the key

terminalGET
$ curl api.beklio.com/api/v1/links?limit=2 \  -H "Authorization: Bearer bk_live_…"HTTP/1.1 200 OK · x-request-id: req_…{  "data": [    { "id": "lnk_…", "slug": "launch", "kind": "DIRECT" },    { "id": "lnk_…", "slug": "docs", "kind": "DIRECT" }  ],  "meta": { "requestId": "req_…" }}$

Getting started

Live in three steps.

From creating a key to production; every step links to the relevant guide.

  1. 01

    Create a key

    In the console, generate a bk_live_ key with only the scopes you need.

    Open console
  2. 02

    Send your first request

    Create your first link with the Authorization header and an Idempotency-Key.

    Quickstart
  3. 03

    Go to production

    Handle error codes, quotas and retry behavior.

    Errors and limits

Resources

Everything you need.

Documentation10 guides: from authentication to error handling.
  • Quickstart
  • Authentication and scopes
  • OAuth 2.0 and PKCE
  • Creating and managing links
API reference45 endpoints with method, path and required scope.
  • GET/api/v1/links
  • POST/api/v1/links
  • GET/api/v1/links/:id
  • PATCH/api/v1/links/:id
Developer consoleKeys, plan usage and a live API tester.
Productionbk_live_•••••••• Active
ToolsDownload the OpenAPI schema and the Postman collection, and try requests with the API tester.beklio-link-openapi.jsonPostman collection

Authorization

Least privilege, by default.

Each key works only with the scopes you select; requests with a missing scope are rejected with 403.

Authentication guide
  • links:readReading links, trees, boards, folders, routes and QR.
  • links:writeCreating, updating, route sub-resources and writing QR.
  • links:deleteDeleting links and sub-resources.
  • analytics:readAnalytics data of your own links.
  • domains:readReading domain metadata.