--- title: "Linkbreakers REST API documentation" description: "Linkbreakers API: base URL, authentication, example requests, endpoints, SDKs and the CLI." canonical: "https://linkbreakers.com/developers" --- # Linkbreakers REST API documentation > REST API for links, QR codes, workflow steps, visitors, events, analytics, webhooks and custom domains. Bearer auth with a workspace API token. ## Base URL `https://api.linkbreakers.com` ## Authentication Send a workspace API token as `Authorization: Bearer `. Create one yourself in the dashboard at https://app.linkbreakers.com/workspace/dashboard/api-tokens after a free signup at https://app.linkbreakers.com?offer=free-plan&ref=landing-free-plan&showcase=default; no sales contact is needed. MCP clients sign in with OAuth 2.1 instead. The full walkthrough for agents is [auth.md](https://linkbreakers.com/auth.md), and the protected resource metadata is at https://api.linkbreakers.com/.well-known/oauth-protected-resource. ## Example requests List API scopes (no token needed): ```bash curl https://api.linkbreakers.com/v1/api-scopes ``` List links: ```bash curl "https://api.linkbreakers.com/v1/links?pageSize=5" \ -H "Authorization: Bearer $LINKBREAKERS_TOKEN" ``` Create a link with a tracked QR code: ```bash curl -X POST https://api.linkbreakers.com/v1/links \ -H "Authorization: Bearer $LINKBREAKERS_TOKEN" \ -H "Content-Type: application/json" \ -d '{"destination": "https://example.com"}' ``` ## Endpoints that need no authentication - `GET https://api.linkbreakers.com/v1/api-scopes`: List API scopes - `GET https://api.linkbreakers.com/v1/pricing/plans`: List pricing plans - `GET https://api.linkbreakers.com/v1/public/page-theme-templates`: List page theme templates - `GET https://api.linkbreakers.com/v1/public/qrcode-templates`: List QR code templates ## Bulk operations - `POST https://api.linkbreakers.com/v1/links/batch`: Create multiple links in a single request - `POST https://api.linkbreakers.com/v1/links/bulk`: Create multiple links in a single request - `POST https://api.linkbreakers.com/v1/links/bulk/jobs`: Create links in bulk in the background ## Endpoints by resource - [Agent Identity](https://linkbreakers.com/help/api/agent-identity) (2 endpoints): Claiming a workspace an AI agent registered for itself. An agent registers at the authorization server (https://mcp.linkbreakers.com/agent/identity, see https://linkbreakers.com/auth.md) and hands a person a claim link and a 6-digit code; these endpoints are the person's side of that ceremony. - [Allowances](https://linkbreakers.com/help/api/allowances) (2 endpoints): What the workspace has used of each limit its plan sets, read from the same counters that enforce them. - [Analytics Dashboard](https://linkbreakers.com/help/api/analytics-dashboard) (6 endpoints): Endpoints for managing analytics dashboards with flexible, config-driven widgets. Each widget defines its own data source and visualization. - [Analytics Data](https://linkbreakers.com/help/api/analytics-data) (11 endpoints): Endpoints for retrieving aggregated analytics data for dashboard widgets including geographic breakdown, device distribution, and visitor trends. - [API Scopes](https://linkbreakers.com/help/api/api-scopes) (1 endpoints): The permissions an API token or OAuth grant can hold. Every authenticated endpoint requires exactly one scope, declared on the operation. - [Assistant](https://linkbreakers.com/help/api/assistant) (4 endpoints): Context-aware assistant that delegates to specialized sub-assistants based on the resource being edited. - [Custom Domains](https://linkbreakers.com/help/api/custom-domains) (8 endpoints): Endpoints for managing custom domains in Linkbreakers. These endpoints allow you to register, verify, and manage custom domains for your workspace. - [Directories](https://linkbreakers.com/help/api/directories) (5 endpoints): Endpoints for managing directories in Linkbreakers. Directories let you organize links and other directories into a hierarchical folder structure. - [Events](https://linkbreakers.com/help/api/events) (2 endpoints): Endpoints for managing events in Linkbreakers. These endpoints allow you to collect data and list events. - [Google Forms Integrations](https://linkbreakers.com/help/api/google-forms-integrations) (7 endpoints): Connect your Google account to automatically sync form responses from links that redirect to Google Forms. - [Jobs](https://linkbreakers.com/help/api/jobs) (1 endpoints): Long-running operations. An endpoint that works in the background answers 202 Accepted with a job and a Location header; poll GET /v1/jobs/{id} until the status is JOB_STATUS_SUCCEEDED or JOB_STATUS_FAILED. Jobs can be read for 24 hours after they finish. - [Link Settings](https://linkbreakers.com/help/api/link-settings) (2 endpoints): Endpoints for managing link-level data collection settings in Linkbreakers. - [Links](https://linkbreakers.com/help/api/links) (13 endpoints): Endpoints for managing shortened links in Linkbreakers. These endpoints allow you to create, retrieve, list, and delete shortened links for your workspace. - [Media](https://linkbreakers.com/help/api/media) (4 endpoints): Endpoints for managing media files in Linkbreakers. These endpoints allow you to upload, retrieve, list, and delete media files for your workspace. - [Members](https://linkbreakers.com/help/api/members) (10 endpoints): Endpoints for managing members in Linkbreakers. These endpoints allow you to invite, retrieve, update, and delete members. - [Page Theme Templates](https://linkbreakers.com/help/api/page-theme-templates) (11 endpoints): Endpoints for managing Page Theme Templates in Linkbreakers. These endpoints allow you to create, retrieve, update, publish, import, and delete reusable page styling. - [Page Themes](https://linkbreakers.com/help/api/page-themes) (5 endpoints): Endpoints for managing page visual themes. These endpoints allow you to create, read, and update themes for canvas, cover, badge, container, typography, and interactive elements. - [Pricing](https://linkbreakers.com/help/api/pricing) (1 endpoints): Public pricing catalog: the plans, what each costs and what each allows. Prices come from the billing provider and limits from the code that enforces them. - [QR Code Designs](https://linkbreakers.com/help/api/qr-code-designs) (5 endpoints): Endpoints for managing QR Code Designs in Linkbreakers. These endpoints allow you to create, retrieve, update, and delete QR Code Designs. - [QR Code Templates](https://linkbreakers.com/help/api/qr-code-templates) (10 endpoints): Endpoints for managing QR Code Templates in Linkbreakers. These endpoints allow you to create, retrieve, update, and delete QR Code Templates. - [Sandboxes](https://linkbreakers.com/help/api/sandboxes) (3 endpoints): Sandbox workspaces for testing an integration without touching live data. A sandbox is a separate, API-only workspace created from your live workspace. Its tokens start with `lb_test_`, and the API refuses a `lb_test_` prefix on a live token. Sandbox usage is never billed and does not count toward your plan: a sandbox has its own monthly caps (1,000 API calls, 500 counted scans and credits for 50 links) and allows no custom domains, members or credit top-ups. Links resolve and webhooks fire normally; a scan of a sandbox link answers with `X-Linkbreakers-Sandbox: true` and `X-Robots-Tag: noindex`. A sandbox and everything in it is deleted 30 days after it was created. A workspace holds at most 3 sandboxes. - [Slack Integrations](https://linkbreakers.com/help/api/slack-integrations) (7 endpoints): Endpoints for managing the Slack integration. Connect your Slack workspace to receive real-time notifications when events occur on your links. - [Tags](https://linkbreakers.com/help/api/tags) (2 endpoints): Endpoints for managing tags in Linkbreakers. These endpoints allow you to search for tags in a workspace. - [Visitors](https://linkbreakers.com/help/api/visitors) (8 endpoints): Identify and manage visitors. Accepts system fields like $email, $phone and arbitrary key/value attributes. - [Webhooks](https://linkbreakers.com/help/api/webhooks) (5 endpoints): Endpoints for managing webhooks in Linkbreakers. These endpoints allow you to create, list, and delete webhooks for event notifications. - [Workflow Steps](https://linkbreakers.com/help/api/workflow-steps) (10 endpoints): Endpoints for managing workflow steps in Linkbreakers. Workflow steps define the behavior of links, such as redirection destinations and data collection flows. - [Workspace Metrics](https://linkbreakers.com/help/api/workspace-metrics) (3 endpoints): Endpoints for analyzing workspace activity within Linkbreakers, covering rolling event totals, audience reach, and calendar heatmaps. - [Workspace Tokens](https://linkbreakers.com/help/api/workspace-tokens) (5 endpoints): Endpoints for managing workspace tokens in Linkbreakers. These endpoints allow you to create, list, and delete workspace tokens for authentication. - [Workspaces](https://linkbreakers.com/help/api/workspaces) (8 endpoints): Endpoints for managing workspaces in Linkbreakers. These endpoints allow you to update and get workspaces. ## Machine-readable descriptions - [OpenAPI](https://linkbreakers.com/openapi.json) (upstream: https://api.linkbreakers.com/internal/openapi/api/v1/api.swagger.json) - [API catalog](https://linkbreakers.com/.well-known/api-catalog) (RFC 9727) - [API llms.txt](https://linkbreakers.com/api/llms.txt) - [Agent view](https://linkbreakers.com/?mode=agent) ## SDKs - TypeScript SDK: package `linkbreakers` on [npm](https://www.npmjs.com/package/linkbreakers), install with `npm install linkbreakers`, docs at https://linkbreakers.com/sdk/typescript, source at https://github.com/linkbreakers-com/linkbreakers-typescript - Python SDK: package `linkbreakers` on [PyPI](https://pypi.org/project/linkbreakers/), install with `pip install linkbreakers`, docs at https://linkbreakers.com/sdk/python, source at https://github.com/linkbreakers-com/linkbreakers-python - Go SDK: package `github.com/linkbreakers-com/linkbreakers-go` on [Go modules](https://pkg.go.dev/github.com/linkbreakers-com/linkbreakers-go), install with `go get github.com/linkbreakers-com/linkbreakers-go`, docs at https://linkbreakers.com/sdk/go, source at https://github.com/linkbreakers-com/linkbreakers-go - Java SDK: package `com.linkbreakers:linkbreakers-sdk` on [Maven Central](https://central.sonatype.com/artifact/com.linkbreakers/linkbreakers-sdk), install with `com.linkbreakers:linkbreakers-sdk`, docs at https://linkbreakers.com/sdk/java, source at https://github.com/linkbreakers-com/linkbreakers-java - Rust SDK: package `linkbreakers` on [crates.io](https://crates.io/crates/linkbreakers), install with `cargo add linkbreakers`, docs at https://linkbreakers.com/sdk/rust, source at https://github.com/linkbreakers-com/linkbreakers-rust ## CLI - Homebrew: `brew install linkbreakers-com/tap/linkbreakers` (https://github.com/linkbreakers-com/homebrew-tap) - Install script (macOS, Linux): `curl -fsSL https://cli.linkbreakers.com/install.sh | bash` - Docs: https://linkbreakers.com/cli, source: https://github.com/linkbreakers-com/linkbreakers-cli ## MCP servers - Linkbreakers MCP: `https://mcp.linkbreakers.com` (oauth2). Create links, QR codes and workflows, and read visitors and analytics in your workspace. - Linkbreakers Docs MCP: `https://linkbreakers.com/mcp` (no sign-in). Search and read the Linkbreakers help center and developer docs. No sign-in required. ## Plans The Free plan costs $0, needs no credit card, and includes the REST API, webhooks and the MCP server. Prices and limits are in [pricing.md](https://linkbreakers.com/pricing.md). Questions: support@linkbreakers.com.