API reference

All public endpoints are served through the gateway under /api/v1/links — this page is public; to send real requests, use the API tester in the console.

Endpoints: 45 endpoints
Groups: 5 groups
Scopes: 5 scopes
Methods: GET 20; POST 8; PATCH 9; DELETE 8

OpenAPI API tester Create key

Links

7 endpoints

Lifecycle of link and route graph resources.

Lists links with cursor pagination and filters.

cURLLink

curl -X GET "https://api.beklio.com/api/v1/links" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Creates a link with the short form (url) or a full route graph.

cURLLink

curl -X POST "https://api.beklio.com/api/v1/links" \
  -H "Authorization: Bearer $BEKLIO_API_KEY" \
  -H "Idempotency-Key: <idempotency-key>" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Returns a link you own, together with its route graph.

cURLLink

curl -X GET "https://api.beklio.com/api/v1/links/{id}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Updates metadata, routing and the route graph.

cURLLink

curl -X PATCH "https://api.beklio.com/api/v1/links/{id}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY" \
  -H "Idempotency-Key: <idempotency-key>" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Deletes the link and its attached graph resources.

cURLLink

curl -X DELETE "https://api.beklio.com/api/v1/links/{id}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Read-only platform/device catalog.

cURLLink

curl -X GET "https://api.beklio.com/api/v1/links/platform-catalog" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Checks whether a slug is free; accepts an optional domainId and excludeLinkId for renaming.
cURLLink
```
curl -X GET "https://api.beklio.com/api/v1/links/links/slug-availability" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Routes

17 endpoints

Targeting conditions, targets and features.

Returns the route list of a link.

cURLLink

curl -X GET "https://api.beklio.com/api/v1/links/{id}/routes" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Adds a new route.

cURLLink

curl -X POST "https://api.beklio.com/api/v1/links/{id}/routes" \
  -H "Authorization: Bearer $BEKLIO_API_KEY" \
  -H "Idempotency-Key: <idempotency-key>" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Returns a single route of a link by routeId.

cURLLink

curl -X GET "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Updates a route.

cURLLink

curl -X PATCH "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY" \
  -H "Idempotency-Key: <idempotency-key>" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Deletes a route.

cURLLink

curl -X DELETE "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Lists route conditions (COUNTRY, DEVICE_PROFILE, OS, USER_AGENT, LANGUAGE, REFERRER_DOMAIN).
cURLLink
```
curl -X GET "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/conditions" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Adds a condition (listed with GET; PATCH/DELETE /:conditionId).

cURLLink

curl -X POST "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/conditions" \
  -H "Authorization: Bearer $BEKLIO_API_KEY" \
  -H "Idempotency-Key: <idempotency-key>" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Partially updates a route condition.

cURLLink

curl -X PATCH "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/conditions/{childId}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY" \
  -H "Idempotency-Key: <idempotency-key>" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Permanently deletes a route condition.

cURLLink

curl -X DELETE "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/conditions/{childId}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Lists the target items of a route (tree or board items).

cURLLink

curl -X GET "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/targets" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Binds a catalog target (listed with GET; PATCH/DELETE /:itemId).

cURLLink

curl -X POST "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/targets" \
  -H "Authorization: Bearer $BEKLIO_API_KEY" \
  -H "Idempotency-Key: <idempotency-key>" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Updates a route target (e.g. its required flag).

cURLLink

curl -X PATCH "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/targets/{childId}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY" \
  -H "Idempotency-Key: <idempotency-key>" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Permanently detaches a target from the route.

cURLLink

curl -X DELETE "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/targets/{childId}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Lists route features: PASSWORD, EXPIRATION_DATE, LIMIT, UTM, REDIRECT_DELAY.
cURLLink
```
curl -X GET "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/features" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Adds a feature (listed with GET; PATCH/DELETE /:featureId).

cURLLink

curl -X POST "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/features" \
  -H "Authorization: Bearer $BEKLIO_API_KEY" \
  -H "Idempotency-Key: <idempotency-key>" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Updates the enabled flag or the config of a route feature.

cURLLink

curl -X PATCH "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/features/{childId}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY" \
  -H "Idempotency-Key: <idempotency-key>" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Permanently removes a feature from the route.

cURLLink

curl -X DELETE "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/features/{childId}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Trees, boards and folders

15 endpoints

Link collections. POST creates, PATCH/DELETE /:id updates and deletes.

Lists your tree resources.

cURLLink

curl -X GET "https://api.beklio.com/api/v1/links/trees" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Creates a link-in-bio tree; username is required (3–64 letters, digits or hyphens).

cURLLink

curl -X POST "https://api.beklio.com/api/v1/links/trees" \
  -H "Authorization: Bearer $BEKLIO_API_KEY" \
  -H "Idempotency-Key: <idempotency-key>" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Returns a single link-in-bio tree by id.

cURLLink

curl -X GET "https://api.beklio.com/api/v1/links/trees/{id}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Partially updates a tree; send only the changed fields.

cURLLink

curl -X PATCH "https://api.beklio.com/api/v1/links/trees/{id}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY" \
  -H "Idempotency-Key: <idempotency-key>" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Permanently deletes a tree.

cURLLink

curl -X DELETE "https://api.beklio.com/api/v1/links/trees/{id}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Lists your board resources.

cURLLink

curl -X GET "https://api.beklio.com/api/v1/links/boards" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Creates a board; title and slug are required, layout is optional.

cURLLink

curl -X POST "https://api.beklio.com/api/v1/links/boards" \
  -H "Authorization: Bearer $BEKLIO_API_KEY" \
  -H "Idempotency-Key: <idempotency-key>" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Returns a single board by id.

cURLLink

curl -X GET "https://api.beklio.com/api/v1/links/boards/{id}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Partially updates a board; send only the changed fields.

cURLLink

curl -X PATCH "https://api.beklio.com/api/v1/links/boards/{id}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY" \
  -H "Idempotency-Key: <idempotency-key>" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Permanently deletes a board.

cURLLink

curl -X DELETE "https://api.beklio.com/api/v1/links/boards/{id}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Lists your folders.

cURLLink

curl -X GET "https://api.beklio.com/api/v1/links/folders" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Creates a folder to organize links; title is required.

cURLLink

curl -X POST "https://api.beklio.com/api/v1/links/folders" \
  -H "Authorization: Bearer $BEKLIO_API_KEY" \
  -H "Idempotency-Key: <idempotency-key>" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Returns a single folder by id.

cURLLink

curl -X GET "https://api.beklio.com/api/v1/links/folders/{id}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Partially updates a folder; send only the changed fields.

cURLLink

curl -X PATCH "https://api.beklio.com/api/v1/links/folders/{id}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY" \
  -H "Idempotency-Key: <idempotency-key>" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Permanently deletes a folder.

cURLLink

curl -X DELETE "https://api.beklio.com/api/v1/links/folders/{id}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

QR and analytics

3 endpoints

QR status and daily analytics.

Reads the QR status and payload.

cURLLink

curl -X GET "https://api.beklio.com/api/v1/links/{id}/qr" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Updates the QR payload and generation state.

cURLLink

curl -X PATCH "https://api.beklio.com/api/v1/links/{id}/qr" \
  -H "Authorization: Bearer $BEKLIO_API_KEY" \
  -H "Idempotency-Key: <idempotency-key>" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Event and visitor totals for ?days=1–365.

cURLLink

curl -X GET "https://api.beklio.com/api/v1/links/{id}/analytics" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Domains

3 endpoints

Available and default domain metadata.

Lists the domains you can read, including short link domains.
cURLLink
```
curl -X GET "https://api.beklio.com/api/v1/links/domains" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Returns your default short link domain (null if none).

cURLLink

curl -X GET "https://api.beklio.com/api/v1/links/domains/default" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Lists the domains you can currently create links on (active and within plan limits).
cURLLink
```
curl -X GET "https://api.beklio.com/api/v1/links/domains/eligible" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```