---
title: "API Reference"
description: "Explore Linkbreakers API documentation. Browse endpoints, payloads, and examples for managing links, events, custom domains, QR code designs, and more."
canonical: "https://linkbreakers.com/help/api"
---

# API Reference

This is a documentation of all the APIs of Linkbreakers ## 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: 600 requests per 60 seconds, per token. - Dashboard session or OAuth token: 500 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. ## 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 ## 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.

## Browse by section

[Agent Identity2 endpointsClaiming 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.](https://linkbreakers.com/help/api/agent-identity)[Allowances2 endpointsWhat the workspace has used of each limit its plan sets, read from the same counters that enforce them.](https://linkbreakers.com/help/api/allowances)[Analytics Dashboard6 endpointsEndpoints for managing analytics dashboards with flexible, config-driven widgets. Each widget defines its own data source and visualization.](https://linkbreakers.com/help/api/analytics-dashboard)[Analytics Data11 endpointsEndpoints for retrieving aggregated analytics data for dashboard widgets including geographic breakdown, device distribution, and visitor trends.](https://linkbreakers.com/help/api/analytics-data)[API Scopes1 endpointsThe permissions an API token or OAuth grant can hold. Every authenticated endpoint requires exactly one scope, declared on the operation.](https://linkbreakers.com/help/api/api-scopes)[Assistant6 endpointsContext-aware assistant that delegates to specialized sub-assistants based on the resource being edited.](https://linkbreakers.com/help/api/assistant)[Auth1 endpointsEndpoints for handling authentication in Linkbreakers. These endpoints allow you to sign in, request password reset, and reset passwords.](https://linkbreakers.com/help/api/auth)[Custom Domains8 endpointsEndpoints for managing custom domains in Linkbreakers. These endpoints allow you to register, verify, and manage custom domains for your workspace.](https://linkbreakers.com/help/api/custom-domains)[Directories5 endpointsEndpoints for managing directories in Linkbreakers. Directories let you organize links and other directories into a hierarchical folder structure.](https://linkbreakers.com/help/api/directories)[Events2 endpointsEndpoints for managing events in Linkbreakers. These endpoints allow you to collect data and list events.](https://linkbreakers.com/help/api/events)[Google Forms Integrations7 endpointsConnect your Google account to automatically sync form responses from links that redirect to Google Forms.](https://linkbreakers.com/help/api/google-forms-integrations)[Jobs1 endpointsLong-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.](https://linkbreakers.com/help/api/jobs)[Link Settings2 endpointsEndpoints for managing link-level data collection settings in Linkbreakers.](https://linkbreakers.com/help/api/link-settings)[Links14 endpointsEndpoints for managing shortened links in Linkbreakers. These endpoints allow you to create, retrieve, list, and delete shortened links for your workspace.](https://linkbreakers.com/help/api/links)[Media10 endpointsEndpoints for managing media files in Linkbreakers. These endpoints allow you to upload, retrieve, list, and delete media files for your workspace.](https://linkbreakers.com/help/api/media)[Members12 endpointsEndpoints for managing members in Linkbreakers. These endpoints allow you to invite, retrieve, update, and delete members.](https://linkbreakers.com/help/api/members)[Page Theme Templates11 endpointsEndpoints for managing Page Theme Templates in Linkbreakers. These endpoints allow you to create, retrieve, update, publish, import, and delete reusable page styling.](https://linkbreakers.com/help/api/page-theme-templates)[Page Themes5 endpointsEndpoints for managing page visual themes. These endpoints allow you to create, read, and update themes for canvas, cover, badge, container, typography, footer logo, and interactive elements.](https://linkbreakers.com/help/api/page-themes)[Pricing1 endpointsPublic 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.](https://linkbreakers.com/help/api/pricing)[QR Code Designs5 endpointsEndpoints for managing QR Code Designs in Linkbreakers. These endpoints allow you to create, retrieve, update, and delete QR Code Designs.](https://linkbreakers.com/help/api/qr-code-designs)[QR Code Templates10 endpointsEndpoints for managing QR Code Templates in Linkbreakers. These endpoints allow you to create, retrieve, update, and delete QR Code Templates.](https://linkbreakers.com/help/api/qr-code-templates)[Slack Integrations7 endpointsEndpoints for managing the Slack integration. Connect your Slack workspace to receive real-time notifications when events occur on your links.](https://linkbreakers.com/help/api/slack-integrations)[Tags2 endpointsEndpoints for managing tags in Linkbreakers. These endpoints allow you to search for tags in a workspace.](https://linkbreakers.com/help/api/tags)[Visitors8 endpointsIdentify and manage visitors. Accepts system fields like $email, $phone and arbitrary key/value attributes.](https://linkbreakers.com/help/api/visitors)[Webhooks5 endpointsEndpoints for managing webhooks in Linkbreakers. These endpoints allow you to create, list, and delete webhooks for event notifications.](https://linkbreakers.com/help/api/webhooks)[Workflow Steps10 endpointsEndpoints for managing workflow steps in Linkbreakers. Workflow steps define the behavior of links, such as redirection destinations and data collection flows.](https://linkbreakers.com/help/api/workflow-steps)[Workspace Metrics3 endpointsEndpoints for analyzing workspace activity within Linkbreakers, covering rolling event totals, audience reach, and calendar heatmaps.](https://linkbreakers.com/help/api/workspace-metrics)[Workspace Tokens5 endpointsEndpoints for managing workspace tokens in Linkbreakers. These endpoints allow you to create, list, and delete workspace tokens for authentication.](https://linkbreakers.com/help/api/workspace-tokens)[Workspaces8 endpointsEndpoints for managing workspaces in Linkbreakers. These endpoints allow you to update and get workspaces.](https://linkbreakers.com/help/api/workspaces)

---

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