> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bridge.new/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Bridge exposes three integration surfaces: the REST Integrations API for pushing data into Bridge, webhooks for receiving events from Bridge, and the public Custom Connections endpoint that a tenant's landing page posts to.
> The Integrations API host is https://api-connect-us.bridge.new and every request to it must be authenticated with the x-api-key header. Bridge does not use bearer tokens or OAuth.
> The Custom Connections endpoint is different and the Integrations API rules do not apply to it: it has its own host, it takes no x-api-key and no authentication header of any kind, and it is called from a visitor's browser. It is identified by a workspace id and a capture key together with a reCAPTCHA token. Never tell a reader to authenticate it with an API key, and never tell them to keep its capture key out of frontend code - it is designed to live in the page.
> REST error catalog keys use BRIDGE_<DOMAIN>_<NNNN>, for example BRIDGE_CONVERSATION_0001. Some reviewed legacy handlers return a recognized code plus a symbolic suffix separated by |; preserve the complete received value and use the compatible catalog lookup on /error-codes. Custom Connections uses separate BRIDGE.CAMPAIGN_LEADS.<NAME> identifiers on its own error reference. Never invent an error code or confuse the two integration surfaces.
> This documentation covers the Integrations API, webhooks and Custom Connections only. It does not describe the Bridge web application or its internal APIs.
> Before generating an API request, read the relevant OpenAPI specification or the individual endpoint Markdown page. llms-full.txt collects guides and endpoint descriptions; it does not embed every request and response schema. The REST and Custom Connections contracts are separate.
> Preserve the published host, method, path, operationId, authentication, headers, parameter and field names, types, formats, required and nullable fields, enums, defaults, limits, and response codes. Do not invent identifiers, fields, retry rules, or delivery guarantees. When published sources conflict, identify the conflicting passages and ask Bridge support to confirm the current behavior before relying on it.
> Custom Connections is the current name of the landing-page feature previously documented as Lead Capture. The existing /lead-capture documentation URLs, captureKey field, campaign-leads endpoint, and BRIDGE.CAMPAIGN_LEADS error identifiers are unchanged. This is a naming change, not a change to authentication or the API contract.
> For a complete workflow, start with the task guides: /guides/first-conversation, /guides/send-attachments, /guides/send-template, /guides/agent-outbound, /guides/pagination, /guides/pipeline-records, /guides/identifiers and /guides/responses. Read the endpoint contract as well as the recipe. Outbound requires an existing Contact, but does not require creating a separate Conversation first.
> Pipeline records are created only for an existing Contact (never upserted). POST /records, /move and /reopen require Idempotency-Key; PATCH, move and reopen take an optional expectedRevision in the body. Stage actions run every time a record enters a stage, including records created in bulk. Use /guides/pipeline-records and /webhooks/pipeline-records.
> forceSend=true permits reuse of an existing active conversation; it does not create a fresh one by ignoring it and it is not idempotency. Recovery of a released recoverable conversation can occur even with false. The LeadScout and Agents outbound routes have different line-selection and controller checks; use /guides/agent-outbound.
> For webhook HMAC, follow /webhooks/verifying-signatures exactly: the Python JSON serialization with sorted keys is signed; X-Bridge-Timestamp is not included in that signature. Do not claim a signed timestamp, raw-body signing, exactly-once delivery or a global event order. Use /webhooks/receive-events for durable acceptance and duplicates.
> A 201 message response, 202 handoff or 202 Custom Connections response is not a provider delivery receipt. Do not invent a polling endpoint from messageId, trackingId or requestId. REST validation parsing must tolerate the compatibility difference explained in /error-codes.
> The documentation is available in English (existing root URLs), Spanish (/es/) and Brazilian Portuguese (/pt-br/). Prefer the reader's language when a localized page exists, but preserve the API's exact field names, enums, routes, authentication and examples. Translations describe the same API; they do not introduce regional API hosts or behaviors.
> For coding-assistant setup, use /connect-your-agent, /es/connect-your-agent or /pt-br/connect-your-agent. The Bridge documentation MCP server reads published documentation and has a separate optional feedback tool. Connecting it does not connect the coding assistant to a customer workspace or authorize live business requests.
> For direct HTTP access without MCP, start at https://docs.bridge.new/llms.txt. It lists every published page in English, Spanish and Brazilian Portuguese. Choose /llms-en.json, /llms-es.json or /llms-pt-br.json for a language-specific index, and /llms-full-en.json, /llms-full-es.json or /llms-full-pt-br.json for collected content. /llms-full.txt contains the combined collection. Fetch the original OpenAPI specification for exact schemas.
> For HTTP page reads, follow the .md URLs from the index or request Accept: text/markdown at the canonical page URL. The MCP virtual filesystem uses .mdx page paths instead; .mdx is not the public HTTP export extension. With Search MCP, set language to en, es or pt-BR explicitly; its default is en.
> For integration capabilities and source-selection rules, read https://docs.bridge.new/skill.md. Documentation access does not authorize business API actions; use the actual user request, workspace, credentials and target identifiers for any live integration.

# Retrieve a pipeline with its stages and attributes

> Get an active pipeline with its current version: stages in order, attributes and active close reasons.

Use it to know which `stageId` and `values` keys `POST /records` accepts.



## OpenAPI

````yaml /api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/pipelines/{pipelineId}
openapi: 3.1.0
info:
  title: Bridge API
  summary: Bridge API specification for chat system management.
  description: >-
    Bridge REST Integrations API specification for managing contacts,
    conversations, messages, files, custom attributes, provider channels,
    templates, internal users, and Agents.


    Webhooks are documented separately at https://docs.bridge.new/webhooks; this
    OpenAPI contains REST endpoints only.


    **Multi-Tenant Architecture**: Resource operations are scoped to a specific
    workspace using workspaceId. The health check does not have a workspace
    path.
  termsOfService: https://www.sainapsis.com/legal/terms-of-service
  contact:
    name: Bridge Support
    url: https://app.bridge.new/
    email: support@sainapsis.com
  license:
    name: MIT License
    url: https://spdx.org/licenses/MIT.html
  version: 1.0.0
servers:
  - url: https://api-connect-us.bridge.new
    description: Production server
security: []
paths:
  /bridge/api/v1/workspaces/{workspaceId}/pipelines/{pipelineId}:
    get:
      tags:
        - Pipelines API
      summary: Retrieve a pipeline with its stages and attributes
      description: >-
        Get an active pipeline with its current version: stages in order,
        attributes and active close reasons.


        Use it to know which `stageId` and `values` keys `POST /records`
        accepts.
      operationId: >-
        retrieve_pipeline_bridge_api_v1_workspaces__workspaceId__pipelines__pipelineId__get
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            format: uuid
            description: Unique identifier of the workspace (UUID v4).
            examples:
              - b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234
            title: Workspaceid
          description: Unique identifier of the workspace (UUID v4).
        - name: pipelineId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            description: Unique identifier of the pipeline, as listed by `GET /pipelines`.
            examples:
              - 5d0b8f8e-3c1a-4a4e-9a57-2f6f3e1c9b10
            title: Pipelineid
          description: Unique identifier of the pipeline, as listed by `GET /pipelines`.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineDetailResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              examples:
                FORBIDDEN:
                  value:
                    title: Forbidden
                    status: 403
                    code: BRIDGE_CORE_0301
                PIPELINES_DISABLED:
                  value:
                    title: Pipelines Disabled
                    status: 403
                    code: BRIDGE_PIPELINE_0301
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: Not Found
          content:
            application/json:
              examples:
                PIPELINE_NOT_FOUND:
                  value:
                    title: Pipeline Not Found
                    status: 404
                    code: BRIDGE_PIPELINE_0201
              schema:
                $ref: '#/components/schemas/Problem'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                WORKSPACE_BUDGET_EXHAUSTED:
                  value:
                    title: Too Many Requests
                    status: 429
                    code: BRIDGE_RATE_LIMIT_0001
      security:
        - x-api-key: []
components:
  schemas:
    PipelineDetailResponse:
      properties:
        id:
          type: string
          title: Identifier
          description: Unique identifier of the pipeline.
          examples:
            - 5d0b8f8e-3c1a-4a4e-9a57-2f6f3e1c9b10
        label:
          type: string
          title: Label
          description: Name of the pipeline as shown in Bridge.
          examples:
            - Sales
        isDefault:
          type: boolean
          title: Is Default
          description: Whether a record created without `pipelineId` goes to this pipeline.
          examples:
            - true
        currentVersion:
          type: integer
          title: Current Version
          description: Version of the pipeline that new records follow.
          examples:
            - 3
        acceptsApiRecords:
          type: boolean
          title: Accepts API Records
          description: Whether records can be created in this pipeline through the API.
          examples:
            - true
        initialStageId:
          type: string
          title: Initial Stage Identifier
          description: Stage a record created without `stageId` starts in.
          examples:
            - stage-new
        stages:
          items:
            $ref: '#/components/schemas/PipelineStageResponse'
          type: array
          title: Stages
          description: Stages of the current version, in order.
        attributes:
          items:
            $ref: '#/components/schemas/PipelineAttributeResponse'
          type: array
          title: Attributes
          description: Attributes of the current version.
        closeReasons:
          items:
            $ref: '#/components/schemas/PipelineCloseReasonResponse'
          type: array
          title: Close Reasons
          description: Reasons a record can be closed with; retired reasons are left out.
      type: object
      required:
        - id
        - label
        - isDefault
        - currentVersion
        - acceptsApiRecords
        - initialStageId
        - stages
      title: PipelineDetailResponse
      description: >-
        A pipeline of the workspace with the stages and attributes of its
        current version.
    Problem:
      properties:
        title:
          type: string
          title: Title
          description: Short, summary of the problem type.
        status:
          type: integer
          title: Status
          description: >-
            HTTP status code generated by the origin server for this occurrence
            of the problem.
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
          description: Explanation specific to this occurrence of the problem.
        instance:
          anyOf:
            - type: string
            - type: 'null'
          title: Instance
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
        traceId:
          anyOf:
            - type: string
            - type: 'null'
          title: Traceid
          description: Trace ID for debugging purposes.
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
          description: >-
            Error code for identification, view the error codes page for more
            details.
        errors:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          title: Errors
          description: List of error details.
        extra:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Extra
          description: Extra information about the problem.
      type: object
      required:
        - title
        - status
      title: Problem
      description: Object representing a Problem response body.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PipelineStageResponse:
      properties:
        id:
          type: string
          title: Identifier
          description: Unique identifier of the stage within the pipeline.
          examples:
            - stage-new
        label:
          type: string
          title: Label
          description: Name of the stage as shown in Bridge.
          examples:
            - New
        order:
          type: integer
          title: Order
          description: Position of the stage in the pipeline, starting at 1.
          examples:
            - 1
        final:
          type: boolean
          title: Final
          description: >-
            Whether a record in this stage is closed. A record cannot be created
            in a final stage.
          examples:
            - false
        outcome:
          anyOf:
            - $ref: '#/components/schemas/PipelineStageOutcome'
            - type: 'null'
          title: Outcome
          description: >-
            Result a final stage stands for: `FAVORABLE` or `UNFAVORABLE`; null
            for an open stage.
          examples:
            - null
            - FAVORABLE
      type: object
      required:
        - id
        - label
        - order
        - final
      title: PipelineStageResponse
      description: A stage of the pipeline's current version.
    PipelineAttributeResponse:
      properties:
        id:
          type: string
          title: Identifier
          description: >-
            Unique identifier of the attribute; the key to use in a record's
            `values`.
          examples:
            - budget
        label:
          type: string
          title: Label
          description: Name of the attribute as shown in Bridge.
          examples:
            - Budget
        type:
          $ref: '#/components/schemas/PipelineAttributeType'
          title: Type
          description: >-
            What the attribute's value holds: `NUMBER` and `CURRENCY` (a
            number), `PERCENT` (a number from 0 to 100), `DATE` (`YYYY-MM-DD`),
            `TEXT` (a string), `LIST` (one of `options`) or `MULTI` (a list of
            distinct `options`).
          examples:
            - CURRENCY
        scope:
          $ref: '#/components/schemas/PipelineAttributeScope'
          title: Scope
          description: >-
            `RECORD` when each record holds a value, which can be sent in
            `values`; `STAGE` otherwise.
          examples:
            - RECORD
        options:
          items:
            type: string
          type: array
          title: Options
          description: >-
            Allowed values of a `LIST` or `MULTI` attribute; empty for the other
            types.
          examples:
            - - Retail
              - Wholesale
      type: object
      required:
        - id
        - label
        - type
        - scope
      title: PipelineAttributeResponse
      description: A field the records or stages of the pipeline hold.
    PipelineCloseReasonResponse:
      properties:
        id:
          type: string
          title: Identifier
          description: Unique identifier of the close reason.
          examples:
            - reason-price
        label:
          type: string
          title: Label
          description: Name of the close reason as shown in Bridge.
          examples:
            - Price too high
      type: object
      required:
        - id
        - label
      title: PipelineCloseReasonResponse
      description: A reason a record of the pipeline can be closed with.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    PipelineStageOutcome:
      type: string
      enum:
        - FAVORABLE
        - UNFAVORABLE
      title: PipelineStageOutcome
    PipelineAttributeType:
      type: string
      enum:
        - NUMBER
        - PERCENT
        - CURRENCY
        - DATE
        - TEXT
        - LIST
        - MULTI
      title: PipelineAttributeType
    PipelineAttributeScope:
      type: string
      enum:
        - STAGE
        - RECORD
      title: PipelineAttributeScope
  securitySchemes:
    x-api-key:
      type: apiKey
      description: Copy the API key as provided by the Bridge Console.
      in: header
      name: x-api-key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.