linkbreakers-com Link Settings API

openapi: 3.2.0
info:
  contact:
    name: Linkbreakers Support
    url: https://app.linkbreakers.com
  description: '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: 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.


    ## 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.'
  title: Linkbreakers Link Settings API
  version: 1.185.0
  x-api-versioning:
    compatibility: additive changes only within a version
    currentVersion: v1
    deprecationHeaders:
    - Deprecation
    - Sunset
    - Link
    minimumNoticeDays: 180
    policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy
    strategy: url-path
servers:
- url: https://api.linkbreakers.com
security:
- bearerAuth: []
tags:
- description: Endpoints for managing link-level data collection settings in Linkbreakers.
  name: Link Settings
paths:
  /v1/settings/link-setting/{id}:
    get:
      description: 'Retrieve the current visitor data collection configuration for a link.


        Requires the `links:read` scope.'
      operationId: SettingsService_GetLinkSetting
      parameters:
      - description: Identifier of the link setting profile (UUID)
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLinkSettingResponse'
          description: Everything worked as expected.
          headers:
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimit-Remaining'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unexpected error
          headers:
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimit-Remaining'
      security:
      - bearerAuth:
        - links:read
      - oauth2:
        - links:read
      summary: Get a link setting
      tags:
      - Link Settings
      x-required-scope: links:read
    put:
      description: 'Adjust the data collection policy associated with a specific link.


        Requires the `links:write` scope.'
      operationId: SettingsService_UpdateLinkSetting
      parameters:
      - description: The ID of the link setting to update (UUID)
        in: path
        name: id
        required: true
        schema:
          type: string
      - description: Makes retrying this request safe. See components.parameters.IdempotencyKey.
        in: header
        name: Idempotency-Key
        required: false
        schema:
          maxLength: 255
          minLength: 1
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SettingsServiceUpdateLinkSettingBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateLinkSettingResponse'
          description: Everything worked as expected.
          headers:
            Idempotent-Replayed:
              $ref: '#/components/headers/Idempotent-Replayed'
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimit-Remaining'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unexpected error
          headers:
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimit-Remaining'
      security:
      - bearerAuth:
        - links:write
      - oauth2:
        - links:write
      summary: Update a link setting
      tags:
      - Link Settings
      x-required-scope: links:write
components:
  headers:
    X-RateLimit-Reset:
      description: Unix time, in seconds, at which the current window resets.
      schema:
        example: 1791650400
        type: integer
    RateLimit-Reset:
      description: Seconds until the current window resets.
      schema:
        example: 42
        type: integer
    RateLimit-Policy:
      description: 'The quota that applies to this caller, as a structured field: `"<name>";q=<requests>;w=<window seconds>` (draft-ietf-httpapi-ratelimit-headers).'
      schema:
        example: '"token";q=600;w=60'
        type: string
    RateLimit-Limit:
      description: Requests allowed in the current window.
      schema:
        example: 600
        type: integer
    Idempotent-Replayed:
      description: true when this response is the stored answer to an earlier request with the same Idempotency-Key.
      schema:
        type: boolean
    X-RateLimit-Limit:
      description: Same as RateLimit-Limit, for clients that read the X- convention.
      schema:
        example: 600
        type: integer
    RateLimit-Remaining:
      description: Requests left in the current window.
      schema:
        example: 598
        type: integer
    RateLimit:
      description: 'What is left of the quota: `"<name>";r=<remaining requests>;t=<seconds until the window resets>` (draft-ietf-httpapi-ratelimit-headers).'
      schema:
        example: '"token";r=598;t=42'
        type: string
    Retry-After:
      description: Seconds to wait before retrying a refused request.
      schema:
        example: 42
        type: integer
    X-RateLimit-Remaining:
      description: Same as RateLimit-Remaining, for clients that read the X- convention.
      schema:
        example: 598
        type: integer
  schemas:
    ErrorResponse:
      properties:
        code:
          description: HTTP status code
          format: int32
          type: integer
        codeType:
          default: UNKNOWN
          description: Custom error code type
          type: string
        details:
          description: Additional error details
          items:
            type: object
          type: array
        message:
          description: Error message
          type: string
      required:
      - code
      - codeType
      - message
      - details
      type: object
    GetLinkSettingResponse:
      description: GetLinkSettingResponse returns the link-setting profile for inspection in the dashboard.
      properties:
        linkSetting:
          $ref: '#/components/schemas/LinkSetting'
      type: object
    LinkSetting:
      description: Stores per-link compliance preferences that drive how Linkbreakers collects visitor data before executing the workflow.
      properties:
        createdAt:
          format: date-time
          title: Timestamp when the setting profile was created
          type: string
        dataCollection:
          $ref: '#/components/schemas/DataCollection'
          example: DATA_COLLECTION_BASIC
          title: Data collection mode that controls visitor prompts and requirements
        id:
          example: fbb5c4b6-2a10-4f35-8cb1-60c613a92d2a
          title: Unique identifier for the link-level setting profile (UUID)
          type: string
        updatedAt:
          format: date-time
          title: Timestamp when the setting profile was last updated
          type: string
      title: LinkSetting
      type: object
    SettingsServiceUpdateLinkSettingBody:
      description: UpdateLinkSettingRequest changes the visitor-data policy tied to a specific link.
      properties:
        dataCollection:
          $ref: '#/components/schemas/DataCollection'
          title: 'The new data collection setting

            Determines how much visitor information is requested during workflow steps'
      type: object
    DataCollection:
      default: DATA_COLLECTION_UNSPECIFIED
      description: "Defines how aggressively Linkbreakers prompts visitors for identifying data before allowing the workflow to continue.\n\n - DATA_COLLECTION_UNSPECIFIED: Data collection preference not specified\n - DATA_COLLECTION_NONE: No visitor data captured; Linkbreakers only logs the scan event.\n - DATA_COLLECTION_BASIC: Minimal data prompts (e.g., email) enabled to keep friction low while identifying high-signal visitors.\n - DATA_COLLECTION_ADVANCED: Full lead capture flows, including custom forms and required fields, before continuing the workflow."
      enum:
      - DATA_COLLECTION_UNSPECIFIED
      - DATA_COLLECTION_NONE
      - DATA_COLLECTION_BASIC
      - DATA_COLLECTION_ADVANCED
      title: DataCollection
      type: string
    UpdateLinkSettingResponse:
      description: UpdateLinkSettingResponse returns the link-setting profile after applying changes.
      properties:
        linkSetting:
          $ref: '#/components/schemas/LinkSetting'
      type: object
  responses:
    TooManyRequests:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Too many requests. Wait the number of seconds in Retry-After, or until the RateLimit window resets, then retry.
      headers:
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimit-Limit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimit-Policy'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimit-Remaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimit-Reset'
        Retry-After:
          $ref: '#/components/headers/Retry-After'
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      description: 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; each operation lists the one scope it requires, and a write scope also grants the read scope of the same resource. GET /v1/api-scopes lists every scope.
      scheme: bearer
      type: http
    oauth2:
      description: OAuth 2.0 authorization code flow with PKCE and dynamic client registration. Request only the scopes you need. The scope names are the same ones workspace API tokens hold.
      flows:
        authorizationCode:
          authorizationUrl: https://mcp.linkbreakers.com/oauth/authorize
          refreshUrl: https://mcp.linkbreakers.com/oauth/token
          scopes:
            analytics:read: Read events, metrics, time series, analytics data and dashboards.
            analytics:write: Create, update and delete analytics dashboards and generate widget summaries.
            assistant:read: Read the Assistant conversation.
            assistant:write: Send files to the Assistant, clear the conversation and contact support.
            billing:write: Open checkout, credit top-up and billing portal sessions.
            domains:read: Read custom domains and their DNS instructions.
            domains:write: Add, verify, update and delete custom domains.
            integrations:read: Read the Slack and Google Forms integrations.
            integrations:write: Connect, configure, test, sync and disconnect the Slack and Google Forms integrations.
            links:read: Read links, their QR code images, tags, folders and link settings.
            links:write: Create, update and delete links, tags, folders and link settings.
            mcp:tools: Full access, including scopes added later.
            media:read: Read uploaded media.
            media:write: Upload and delete media.
            members:read: Read workspace members.
            members:write: Update, revoke, sign out and remove members. Inviting a member or changing a sign-in email or password needs full access.
            page_themes:read: Read page themes and page theme templates.
            page_themes:write: Change page themes and create, publish and delete page theme templates.
            qrcodes:read: Read QR code designs and QR code templates.
            qrcodes:write: Change QR code designs and create, publish and delete QR code templates.
            tokens:read: Read API tokens and their scopes, never their secrets.
            tokens:write: Create, update and delete API tokens, limited to the scopes the calling token holds.
            visitors:read: Read and search visitors and their attributes.
            visitors:write: Identify, update and delete visitors and their attributes.
            webhooks:read: Read webhooks.
            webhooks:write: Create, update and delete webhooks.
            workflows:read: Read the workflow steps behind a link and validate them.
            workflows:write: Create, connect, update, lay out and delete workflow steps.
            workspace:read: Read the workspace and its settings.
            workspace:write: Update the workspace, request enrollment and delete the workspace.
          tokenUrl: https://mcp.linkbreakers.com/oauth/token
      type: oauth2