# 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 - [Agents](https://linkbreakers.com/help/api/agents): 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. (9 operations) - [Analytics](https://linkbreakers.com/help/api/analytics): 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. (16 operations) - [Analytics Dashboards](https://linkbreakers.com/help/api/analytics-dashboards): Saved analytics dashboards, for the whole workspace or one link: each widget names its data source and how it is charted. (6 operations) - [Custom Domains](https://linkbreakers.com/help/api/custom-domains): 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. (7 operations) - [Directories](https://linkbreakers.com/help/api/directories): Folders for your links: directories hold links and other directories, as a tree. (5 operations) - [Events](https://linkbreakers.com/help/api/events): Every scan and visit as a raw event, and the workflow steps each visitor went through. (2 operations) - [Integrations: Contact Tools](https://linkbreakers.com/help/api/integrations-contact-tools): 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. (10 operations) - [Integrations: Forms](https://linkbreakers.com/help/api/integrations-forms): Connect Google Forms, Tally, Typeform, Jotform or Paperform: each response is attached to the visitor whose visit opened the form. (8 operations) - [Integrations: Google Analytics](https://linkbreakers.com/help/api/integrations-google-analytics): Send every scan, visit, form submission and captured visitor detail to your Google Analytics 4 property, server side. (4 operations) - [Integrations: Retargeting Pixels](https://linkbreakers.com/help/api/integrations-retargeting-pixels): 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. (3 operations) - [Integrations: Slack](https://linkbreakers.com/help/api/integrations-slack): Post scans, visits and form submissions on your links to a Slack channel as they happen. (5 operations) - [Link Jobs](https://linkbreakers.com/help/api/link-jobs): Follow links being created in the background. Start a bulk creation with `POST /v1/links/bulk/jobs`, then read the job here until it is done. (1 operations) - [Link Settings](https://linkbreakers.com/help/api/link-settings): How much identifying data visitors are asked for: the workspace's data collection level and each link's settings. (4 operations) - [Links](https://linkbreakers.com/help/api/links): 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. (15 operations) - [Media](https://linkbreakers.com/help/api/media): Your media library: images, PDFs and videos for link pages, QR codes and workflow steps. Upload, import from a URL, replace and delete. (11 operations) - [Members](https://linkbreakers.com/help/api/members): The people in your workspace: invite them, change their role, revoke or restore their access, sign them out, remove them. (9 operations) - [Page Theme Templates](https://linkbreakers.com/help/api/page-theme-templates): Reusable page looks: save a link's theme as a template, publish it, import a public one, and apply it to links. (10 operations) - [Page Themes](https://linkbreakers.com/help/api/page-themes): 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. (5 operations) - [Pricing](https://linkbreakers.com/help/api/pricing): The public plan catalog: what each plan costs and what it allows. No authentication needed. (1 operations) - [QR Code Designs](https://linkbreakers.com/help/api/qr-code-designs): 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. (5 operations) - [QR Code Templates](https://linkbreakers.com/help/api/qr-code-templates): Reusable QR code designs: save one, publish it, import a public one, and apply it to links. (9 operations) - [Tags](https://linkbreakers.com/help/api/tags): The labels you put on links to group and filter them: list them, or delete tags from every link that carries them. (2 operations) - [Visitors](https://linkbreakers.com/help/api/visitors): 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. (9 operations) - [Webhooks](https://linkbreakers.com/help/api/webhooks): Your own URLs, called with each event you subscribe them to (scans, visits, form submissions). (5 operations) - [Workflow Steps](https://linkbreakers.com/help/api/workflow-steps): What happens when someone opens a link: the steps (redirects, forms, pages, conditions, a chat bot) and where each step's exits lead. (12 operations) - [Workspace Tokens](https://linkbreakers.com/help/api/workspace-tokens): The API tokens that authenticate these endpoints: create, list, update and revoke them. (6 operations) - [Workspaces](https://linkbreakers.com/help/api/workspaces): Your workspace: read and update its settings, see how much of its plan it has used, or delete it. (5 operations) ## Endpoints that need no authentication - `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 - `GET https://api.linkbreakers.com/v1/workspace-tokens/scopes`: List the scopes a token can have ## Bulk endpoints - `POST https://api.linkbreakers.com/v1/links/batch`: Create multiple links from a bare JSON array - `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.204.1](https://www.npmjs.com/package/linkbreakers/v/1.204.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.204.1](https://pypi.org/project/linkbreakers/1.204.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.204.1](https://pkg.go.dev/github.com/linkbreakers-com/linkbreakers-go@v1.204.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.204.1](https://central.sonatype.com/artifact/com.linkbreakers/linkbreakers-sdk/1.204.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.204.1](https://crates.io/crates/linkbreakers/1.204.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.204.1](https://github.com/linkbreakers-com/linkbreakers-cli/releases/tag/v1.204.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.204.1](https://www.npmjs.com/package/linkbreakers-cli/v/1.204.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.204.1](https://www.npmjs.com/package/linkbreakers-mcp/v/1.204.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 `analytics_workspace_metric`). - [MCP server: Linkbreakers Docs MCP](https://linkbreakers.com/mcp): `https://linkbreakers.com/mcp`