---
title: "Linkbreakers API Reference: endpoints, auth and examples"
description: "The Linkbreakers REST API reference: every endpoint for links, QR codes, workflows, visitors and analytics, with authentication, errors, rate limits and examples."
canonical: "https://linkbreakers.com/help/api"
---

# API Reference

One REST API for links, QR codes, workflows, visitors and analytics: JSON over HTTPS, authenticated with a Bearer token.

Base URL `https://api.linkbreakers.com`

v1.200.2

[OpenAPI document](https://api.linkbreakers.com/openapi.json) [SDKs, CLI and MCP](https://linkbreakers.com/developers)

## Getting started

1. Create an API token in the dashboard, under [Settings, API tokens](https://app.linkbreakers.com/settings/api-tokens). Give it full access or only the scopes it needs.
2. Send it on every request as `Authorization: Bearer <token>`, to `https://api.linkbreakers.com`.
3. Requests and responses are JSON. Field names are camelCase.

Your first call

```bash
curl "https://api.linkbreakers.com/v1/links?pageSize=10" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN"
```

## Endpoints by section

* [Agents 9 endpoints: AI chat personas you build (a role, a tone, guardrails and knowledge documents) and plug into a link's Chat Bot step, where they talk to your visitors.](https://linkbreakers.com/help/api/agents)
* [Analytics 16 endpoints: Scan and visit numbers: rolling workspace totals, time series, and breakdowns by country, device, hour, link or workflow step, with funnels, A/B splits and visitor attributes.](https://linkbreakers.com/help/api/analytics)
* [Analytics Dashboards 6 endpoints: Saved analytics dashboards, for the whole workspace or one link: each widget names its data source and how it is charted.](https://linkbreakers.com/help/api/analytics-dashboards)
* [Custom Domains 7 endpoints: Your own domain for short links and QR codes: add it, get the DNS records to set, and check it is live with its certificate.](https://linkbreakers.com/help/api/custom-domains)
* [Directories 5 endpoints: Folders for your links: directories hold links and other directories, as a tree.](https://linkbreakers.com/help/api/directories)
* [Events 2 endpoints: Every scan and visit as a raw event, and the workflow steps each visitor went through.](https://linkbreakers.com/help/api/events)
* [Integrations: Contact Tools 10 endpoints: Send the people who scan your QR codes and fill your forms to the tool you reach customers with (CRMs and email marketing tools), as contacts on a list or audience.](https://linkbreakers.com/help/api/integrations-contact-tools)
* [Integrations: Forms 8 endpoints: Connect Google Forms, Tally, Typeform, Jotform or Paperform: each response is attached to the visitor whose visit opened the form.](https://linkbreakers.com/help/api/integrations-forms)
* [Integrations: Google Analytics 4 endpoints: Send every scan, visit, form submission and captured visitor detail to your Google Analytics 4 property, server side.](https://linkbreakers.com/help/api/integrations-google-analytics)
* [Integrations: Retargeting Pixels 3 endpoints: Fire your ad platforms' pixels (Meta, Google, TikTok, LinkedIn, Google Tag Manager) when someone opens one of your links or scans one of your QR codes, to retarget them later.](https://linkbreakers.com/help/api/integrations-retargeting-pixels)
* [Integrations: Slack 5 endpoints: Post scans, visits and form submissions on your links to a Slack channel as they happen.](https://linkbreakers.com/help/api/integrations-slack)
* [Jobs 1 endpoint: Follow a bulk link creation that runs in the background. Start it with POST /v1/links/bulk/jobs, then check it here until it is done.](https://linkbreakers.com/help/api/jobs)
* [Link Settings 4 endpoints: How much identifying data visitors are asked for: the workspace's data collection level and each link's settings.](https://linkbreakers.com/help/api/link-settings)
* [Links 15 endpoints: Short links and their QR codes: create them (one at a time, in bulk or in the background), read, update and delete them, and render their QR code images.](https://linkbreakers.com/help/api/links)
* [Media 11 endpoints: Your media library: images, PDFs and videos for link pages, QR codes and workflow steps. Upload, import from a URL, replace and delete.](https://linkbreakers.com/help/api/media)
* [Members 9 endpoints: The people in your workspace: invite them, change their role, revoke or restore their access, sign them out, remove them.](https://linkbreakers.com/help/api/members)
* [Page Theme Templates 10 endpoints: Reusable page looks: save a link's theme as a template, publish it, import a public one, and apply it to links.](https://linkbreakers.com/help/api/page-theme-templates)
* [Page Themes 5 endpoints: The look of a link's pages (colors, fonts, cover, badge, buttons): read and update one link's theme, or restyle many links at once.](https://linkbreakers.com/help/api/page-themes)
* [Pricing 1 endpoint: The public plan catalog: what each plan costs and what it allows. No authentication needed.](https://linkbreakers.com/help/api/pricing)
* [QR Code Designs 5 endpoints: The look of a link's QR code: colors, dot and corner shapes, and the logo in its center. Apply a template to a link's code.](https://linkbreakers.com/help/api/qr-code-designs)
* [QR Code Templates 9 endpoints: Reusable QR code designs: save one, publish it, import a public one, and apply it to links.](https://linkbreakers.com/help/api/qr-code-templates)
* [Tags 2 endpoints: The labels you put on links to group and filter them: list them, or delete tags from every link that carries them.](https://linkbreakers.com/help/api/tags)
* [Visitors 9 endpoints: The people who scan your QR codes or open your links: identify them with your own data ($email, $phone, any key), read, search, update and delete them.](https://linkbreakers.com/help/api/visitors)
* [Webhooks 5 endpoints: Your own URLs, called with each event you subscribe them to (scans, visits, form submissions).](https://linkbreakers.com/help/api/webhooks)
* [Workflow Steps 12 endpoints: What happens when someone opens a link: the steps (redirects, forms, pages, conditions, a chat bot) and where each step's exits lead.](https://linkbreakers.com/help/api/workflow-steps)
* [Workspace Tokens 6 endpoints: The API tokens that authenticate these endpoints: create, list, update and revoke them.](https://linkbreakers.com/help/api/workspace-tokens)
* [Workspaces 5 endpoints: Your workspace: read and update its settings, see how much of its plan it has used, or delete it.](https://linkbreakers.com/help/api/workspaces)

## Authentication

JWT Bearer token authentication. Use a workspace API token obtained from the Linkbreakers dashboard. When using the SDK, pass this token to the `accessToken` field in the Configuration constructor (not `apiKey`). A token has full access or a list of scopes; every authenticated endpoint requires exactly one scope, named on the endpoint, and a write scope also grants the read scope of the same resource. GET /v1/workspace-tokens/scopes lists every scope.

[List the scopes a token can have](https://linkbreakers.com/help/api/workspace-tokens#list-the-scopes-a-token-can-have).

## Errors

A failed request answers a 4xx or 5xx status with the same JSON object. `codeType` is stable and meant for code; `message` is for people.

`code` integer (int32) 

Required

The gRPC status code (google.rpc.Code), for example 3 for an invalid argument, 5 for not found or 16 for missing credentials. The HTTP status is the response's own.

`codeType` string 

Required

A stable, machine-readable code for this error, such as `AUTH_REQUIRED` or `LINK_NOT_FOUND`. Branch on it rather than on the message.

`details` array of object 

Required

Additional details, when the error has any.

`message` string 

Required

What went wrong, for people. Its wording can change.

Example error

```json
{
  "code": 16,
  "codeType": "AUTH_REQUIRED",
  "message": "authentication required",
  "details": []
}
```

## Entry points

`GET https://api.linkbreakers.com/` and `GET https://api.linkbreakers.com/v1` answer without credentials with the API's name, version and links. This document is served at `https://api.linkbreakers.com/openapi.json`.

## Rate limits

Every response describes where the caller stands in the IETF `RateLimit-Policy` and `RateLimit` header fields (draft-ietf-httpapi-ratelimit-headers), and in `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset` and `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (a Unix timestamp) for clients that read those. A request past the limit gets `429 Too Many Requests` with `Retry-After` in seconds.

* Workspace API token: 720 requests per 60 seconds, per token.
* Dashboard session or OAuth token: 600 requests per 60 seconds, per token.
* No credentials: 300 requests per 60 seconds, per client IP.

Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes.

## Pagination

Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`.

## Batches and background jobs

`POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish.

## Paused workspaces

A free workspace whose members have not verified any email address is paused 7 days after sign-up. Its calls then answer `403` with the code `WORKSPACE_UNVERIFIED` and change nothing; QR codes and links keep working for visitors. To lift the pause, ask the workspace owner to verify their email: `POST /v1/members/email-verification` sends the verification email again, and works while the workspace is paused. `unverifiedPauseAt` on the workspace says when the pause starts.

## Versioning and deprecation

The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead.

An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel="deprecation"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: <https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy>

A renamed operation keeps answering its former path while clients still call it, until that path's sunset at the latest: a former path no client calls for 14 days is removed. Responses on a former path carry the same `Deprecation`, `Sunset` and `Link` header fields; this document lists only the current path, and the policy lists the former paths that still answer.

## Idempotent retries

Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.

## Identifying your client

Send a `Linkbreakers-Client` request header saying which client made the call: `<client>/<version> (<details>)`, for example `my-integration/1.2.0 (python 3.12; linux)`. The official SDKs, the CLI and the MCP bridge set it for you, as `sdk-python/2.3.1 (python 3.12.4; linux)` or `cli/1.4.0 (darwin arm64)`. It is optional and changes nothing about how a request is handled; it tells us which clients and versions are in use, so we know what can be retired and what to fix first. Keep the details short and free of personal data. Browsers may send it too: it is allowed by CORS.

---

Source: https://linkbreakers.com/help/api
