Breakreach Connect Links API

openapi: 3.2.0
info:
  title: Breakreach Connect Links API
  version: 1.1.0
  description: 'Publish and schedule social media posts across Instagram, TikTok, X (Twitter), Reddit, LinkedIn, YouTube, Facebook, Threads, Bluesky, Pinterest, Telegram, Discord, Slack, Mastodon, WordPress, Ghost, Dev.to, Hashnode, Tumblr and Google Business Profile with one request shape.


    Authenticate with an API key (create one in the Breakreach dashboard under Settings → API & MCP) sent as a Bearer token. Errors answer with an HTTP status and a JSON body { "error": "" }.


    Every POST accepts an Idempotency-Key header: any unique string up to 255 characters, a UUID for instance. Retrying with the same key and the same body within 24 hours returns the first response, marked Idempotent-Replayed: true, instead of creating a second post. The same key with a different body answers 422, and 409 while the first request is still running. Errors are not kept, so a fixed request can reuse its key. Keys belong to the API key that sent them.


    AI agents can use the same capabilities through the hosted MCP server at https://api.breakreach.com/mcp (OAuth 2.1).'
servers:
- url: https://api.breakreach.com
security:
- bearerAuth: []
tags:
- name: Connect Links
paths:
  /v1/connect-links:
    post:
      summary: Create a connect link
      description: Creates a hosted page where someone without a Breakreach login (your end user, your client) connects social accounts into a workspace. Send them the url; they pick a network, authorize it, and come back to the page, then to redirectUrl when they click Done, with ?connected=&workspace= appended. Accounts connected this way fire the account.connected webhook and count toward your plan. Only the workspace owner can create links.
      operationId: createConnectLink
      parameters:
      - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                workspace:
                  type: string
                  description: Workspace slug (optional, defaults to your first workspace)
                platforms:
                  type: array
                  items:
                    type: string
                    enum:
                    - instagram
                    - facebook
                    - threads
                    - tiktok
                    - linkedin
                    - youtube
                    - x
                    - pinterest
                    - bluesky
                    - reddit
                    - telegram
                    - discord
                    - slack
                    - mastodon
                    - wordpress
                    - ghost
                    - devto
                    - hashnode
                    - tumblr
                    - googlebusiness
                  description: 'Networks offered on the page (default: all)'
                redirectUrl:
                  type: string
                  format: uri
                  description: 'Where the Done button sends them: https, or http on localhost'
                expiresInHours:
                  type: integer
                  minimum: 1
                  maximum: 168
                  description: How long the link works (default 24)
      responses:
        '200':
          description: Created
          content:
            application/json:
              schema:
                type: object
                required:
                - connectLink
                properties:
                  connectLink:
                    $ref: '#/components/schemas/ConnectLink'
        '400':
          description: Unknown platform, invalid redirectUrl or expiresInHours
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: Workspace not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          $ref: '#/components/responses/IdempotencyRunning'
        '422':
          $ref: '#/components/responses/IdempotencyMismatch'
      tags:
      - Connect Links
  /v1/connect-links/{id}:
    get:
      summary: Get a connect link
      description: Its status (active, expired or revoked) and the accounts connected through it. The url is only returned when the link is created.
      operationId: getConnectLink
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                - connectLink
                properties:
                  connectLink:
                    $ref: '#/components/schemas/ConnectLink'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '404':
          description: Connect link not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Connect Links
    delete:
      summary: Revoke a connect link
      description: The page stops working at once. Accounts already connected through it stay connected.
      operationId: revokeConnectLink
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Revoked
          content:
            application/json:
              schema:
                type: object
                required:
                - connectLink
                properties:
                  connectLink:
                    $ref: '#/components/schemas/ConnectLink'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '404':
          description: Connect link not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Connect Links
components:
  responses:
    Unauthorized:
      description: Missing, invalid or expired API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    IdempotencyRunning:
      description: 'A request with this Idempotency-Key is still running: retry after Retry-After seconds to get its response'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    PaymentRequired:
      description: No active Breakreach subscription or trial
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    IdempotencyMismatch:
      description: This Idempotency-Key was already used with a different request in the last 24 hours
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Not a member of the requested workspace
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: string
          description: Human-readable reason
    ConnectLink:
      type: object
      required:
      - id
      - workspace
      - platforms
      - redirectUrl
      - expiresAt
      - status
      - connected
      properties:
        id:
          type: string
        url:
          type: string
          format: uri
          description: The page to send, only returned at creation
        workspace:
          type: string
          description: Workspace slug
        platforms:
          type: array
          items:
            type: string
        redirectUrl:
          type:
          - string
          - 'null'
        expiresAt:
          type: string
          format: date-time
        status:
          type: string
          enum:
          - active
          - expired
          - revoked
        connected:
          type: array
          items:
            type: object
            required:
            - accountId
            - platform
            - displayName
            - connectedAt
            properties:
              accountId:
                type: string
              platform:
                type: string
              displayName:
                type: string
              connectedAt:
                type: string
                format: date-time
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      schema:
        type: string
        minLength: 1
        maxLength: 255
      description: 'A unique string for this request, e.g. a UUID. A retry with the same key and body within 24 hours returns the first response (with the header Idempotent-Replayed: true) instead of running again. Printable ASCII, no spaces.'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key from the Breakreach dashboard (br_...) or an OAuth access token (bro_...)