# Linkbreakers API > REST API for links, QR codes, workflow steps, media (PDFs, images, videos), visitors, events, analytics, webhooks and custom domains. Bearer auth with a workspace API token. Base URL: https://api.linkbreakers.com. Authenticate with a workspace API token sent as `Authorization: Bearer `. - [REST API documentation](https://linkbreakers.com/developers.md): Authentication, example requests and endpoints - [API reference](https://linkbreakers.com/help/api): Endpoints, parameters and schemas - [OpenAPI](https://linkbreakers.com/openapi.json): Machine-readable description (upstream: https://api.linkbreakers.com/internal/openapi/api/v1/api.swagger.json) - [Authentication](https://linkbreakers.com/auth.md): Creating and using workspace API tokens - [auth.md](https://linkbreakers.com/auth.md): Credentials walkthrough for agents - [API catalog](https://linkbreakers.com/.well-known/api-catalog): RFC 9727 catalog ## Resources - [Agent Identity](https://linkbreakers.com/help/api/agent-identity): 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. (2 operations) - [Agents](https://linkbreakers.com/help/api/agents): Agents are chat personas a workspace builds: a role, a tone, guardrails and knowledge documents. An agent talks to visitors from the workflow steps it is plugged into, such as the Chat Bot step. (9 operations) - [Allowances](https://linkbreakers.com/help/api/allowances): What the workspace has used of each limit its plan sets, read from the same counters that enforce them. (2 operations) - [Analytics Dashboard](https://linkbreakers.com/help/api/analytics-dashboard): Endpoints for managing analytics dashboards with flexible, config-driven widgets. Each widget defines its own data source and visualization. (6 operations) - [Analytics Data](https://linkbreakers.com/help/api/analytics-data): Endpoints for retrieving aggregated analytics data for dashboard widgets including geographic breakdown, device distribution, and visitor trends. (14 operations) - [API Scopes](https://linkbreakers.com/help/api/api-scopes): The permissions an API token or OAuth grant can hold. Every authenticated endpoint requires exactly one scope, declared on the operation. (1 operations) - [Assistant](https://linkbreakers.com/help/api/assistant): Context-aware assistant that delegates to specialized sub-assistants based on the resource being edited. (6 operations) - [Auth](https://linkbreakers.com/help/api/auth): Endpoints for handling authentication in Linkbreakers. These endpoints allow you to sign in, request password reset, and reset passwords. (1 operations) - [Custom Domains](https://linkbreakers.com/help/api/custom-domains): Endpoints for managing custom domains in Linkbreakers. These endpoints allow you to register, verify, and manage custom domains for your workspace. (8 operations) - [Directories](https://linkbreakers.com/help/api/directories): Endpoints for managing directories in Linkbreakers. Directories let you organize links and other directories into a hierarchical folder structure. (5 operations) - [Events](https://linkbreakers.com/help/api/events): Endpoints for managing events in Linkbreakers. These endpoints allow you to collect data and list events. (2 operations) - [Google Analytics Integrations](https://linkbreakers.com/help/api/google-analytics-integrations): Send every QR code scan and link visit, form submission and piece of visitor data captured to Google Analytics 4, server side through the Measurement Protocol, with no delay for the visitor. (4 operations) - [Google Forms Integrations](https://linkbreakers.com/help/api/google-forms-integrations): Connect your Google account to automatically sync form responses from links that redirect to Google Forms. (7 operations) - [Jobs](https://linkbreakers.com/help/api/jobs): 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. (1 operations) - [Link Settings](https://linkbreakers.com/help/api/link-settings): Endpoints for managing link-level data collection settings in Linkbreakers. (4 operations) - [Links](https://linkbreakers.com/help/api/links): Endpoints for managing shortened links in Linkbreakers. These endpoints allow you to create, retrieve, list, and delete shortened links for your workspace. (15 operations) - [Media](https://linkbreakers.com/help/api/media): Endpoints for managing media files in Linkbreakers. These endpoints allow you to upload, retrieve, list, and delete media files for your workspace. (10 operations) - [Members](https://linkbreakers.com/help/api/members): Endpoints for managing members in Linkbreakers. These endpoints allow you to invite, retrieve, update, and delete members. (13 operations) - [Page Theme Templates](https://linkbreakers.com/help/api/page-theme-templates): Endpoints for managing Page Theme Templates in Linkbreakers. These endpoints allow you to create, retrieve, update, publish, import, and delete reusable page styling. (11 operations) - [Page Themes](https://linkbreakers.com/help/api/page-themes): Endpoints for managing page visual themes. These endpoints allow you to create, read, and update themes for canvas, cover, badge, container, typography, footer logo, visitor experience, and interactive elements. (6 operations) - [Pricing](https://linkbreakers.com/help/api/pricing): 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. (1 operations) - [QR Code Designs](https://linkbreakers.com/help/api/qr-code-designs): Endpoints for managing QR Code Designs in Linkbreakers. These endpoints allow you to create, retrieve, update, and delete QR Code Designs. (5 operations) - [QR Code Templates](https://linkbreakers.com/help/api/qr-code-templates): Endpoints for managing QR Code Templates in Linkbreakers. These endpoints allow you to create, retrieve, update, and delete QR Code Templates. (10 operations) - [Retargeting Pixels](https://linkbreakers.com/help/api/retargeting-pixels): Fire your ad platforms' retargeting pixels (Meta, Google, TikTok, LinkedIn, Google Tag Manager) when someone visits one of your links or scans one of your QR codes, so you can retarget them later. (3 operations) - [Review Rewards](https://linkbreakers.com/help/api/review-rewards): Three months of the Pro plan for free in exchange for an honest review of Linkbreakers on G2, Capterra or Trustpilot. (2 operations) - [Slack Integrations](https://linkbreakers.com/help/api/slack-integrations): Endpoints for managing the Slack integration. Connect your Slack workspace to receive real-time notifications when events occur on your links. (7 operations) - [Tags](https://linkbreakers.com/help/api/tags): Endpoints for managing tags in Linkbreakers. These endpoints allow you to search for tags in a workspace. (2 operations) - [Visitors](https://linkbreakers.com/help/api/visitors): Identify and manage visitors. Accepts system fields like $email, $phone and arbitrary key/value attributes. (8 operations) - [Webhooks](https://linkbreakers.com/help/api/webhooks): Endpoints for managing webhooks in Linkbreakers. These endpoints allow you to create, list, and delete webhooks for event notifications. (5 operations) - [Workflow Steps](https://linkbreakers.com/help/api/workflow-steps): Endpoints for managing workflow steps in Linkbreakers. Workflow steps define the behavior of links, such as redirection destinations and data collection flows. (12 operations) - [Workspace Metrics](https://linkbreakers.com/help/api/workspace-metrics): Endpoints for analyzing workspace activity within Linkbreakers, covering rolling event totals, audience reach, and calendar heatmaps. (3 operations) - [Workspace Tokens](https://linkbreakers.com/help/api/workspace-tokens): Endpoints for managing workspace tokens in Linkbreakers. These endpoints allow you to create, list, and delete workspace tokens for authentication. (5 operations) - [Workspaces](https://linkbreakers.com/help/api/workspaces): Endpoints for managing workspaces in Linkbreakers. These endpoints allow you to update and get workspaces. (8 operations) ## 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 endpoints - `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 - `POST https://api.linkbreakers.com/v1/page-themes/bulk-update`: Restyle many links' page themes - `POST https://api.linkbreakers.com/v1/workflow-steps/bulk-insert`: Insert one step into many links' workflows ## SDKs - TypeScript SDK: package `linkbreakers` on [npm](https://www.npmjs.com/package/linkbreakers), latest version [1.194.1](https://www.npmjs.com/package/linkbreakers/v/1.194.1), 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/), latest version [1.194.1](https://pypi.org/project/linkbreakers/1.194.1/), 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), latest version [1.194.1](https://pkg.go.dev/github.com/linkbreakers-com/linkbreakers-go@v1.194.1), 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), latest version [1.194.1](https://central.sonatype.com/artifact/com.linkbreakers/linkbreakers-sdk/1.194.1), 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), latest version [1.194.1](https://crates.io/crates/linkbreakers/1.194.1), install with `cargo add linkbreakers`, docs at https://linkbreakers.com/sdk/rust, source at https://github.com/linkbreakers-com/linkbreakers-rust ## CLI and MCP - [CLI](https://linkbreakers.com/cli): source at https://github.com/linkbreakers-com/linkbreakers-cli, latest release [v1.194.1](https://github.com/linkbreakers-com/linkbreakers-cli/releases/tag/v1.194.1) - No account or token yet: `npx -y linkbreakers-cli signup --email ` creates a workspace and saves its API token in one command - CLI via Homebrew: `brew install linkbreakers-com/tap/linkbreakers` ([registry](https://github.com/linkbreakers-com/homebrew-tap)) - CLI via Install script (macOS, Linux): `curl -fsSL https://cli.linkbreakers.com/install.sh | bash` - CLI via npm: `npm install -g linkbreakers-cli` ([registry](https://www.npmjs.com/package/linkbreakers-cli), latest [1.194.1](https://www.npmjs.com/package/linkbreakers-cli/v/1.194.1)) - [MCP server: Linkbreakers MCP](https://linkbreakers.com/help/article/mcp-server-setup): `https://mcp.linkbreakers.com` Local stdio server: `npx -y linkbreakers-mcp` (package `linkbreakers-mcp` on [npm](https://www.npmjs.com/package/linkbreakers-mcp), latest [1.194.1](https://www.npmjs.com/package/linkbreakers-mcp/v/1.194.1), source at https://github.com/linkbreakers-com/linkbreakers-mcp) Linkbreakers MCP supports MCP Apps (`io.modelcontextprotocol/ui`, `text/html;profile=mcp-app`) and the OpenAI Apps SDK (`openai/outputTemplate`): tool results render as interactive UI in the conversation. Views: Link card (`ui://linkbreakers/link-card.html`, for `links_create`, `links_get`); Visitors (`ui://linkbreakers/visitors-card.html`, for `visitors_list`); Workspace metrics (`ui://linkbreakers/workspace-metrics.html`, for `metrics_workspace`). - [MCP server: Linkbreakers Docs MCP](https://linkbreakers.com/mcp): `https://linkbreakers.com/mcp`