> ## 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/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.
> 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.

# Obter contato por um identificador

> Obtém um contato específico por qualquer um de seus identificadores no workspace.

`type=ID` retorna o mesmo contato que GET /contacts/{contactId}, a URL canônica de um contato e a opção preferida quando você já tem seu ID.



## OpenAPI

````yaml /pt-br/api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/contacts/lookup
openapi: 3.1.0
info:
  title: Bridge API
  summary: Especificação da API do Bridge para gerenciar o sistema de chat.
  description: >-
    Especificação da API REST de integrações do Bridge para gerenciar contatos,
    conversas, mensagens, arquivos, atributos personalizados, canais de
    provedores, modelos, usuários internos e Agents.


    Os webhooks são documentados separadamente em
    https://docs.bridge.new/pt-br/webhooks; este OpenAPI contém apenas endpoints
    REST.


    **Arquitetura multiempresa**: as operações sobre recursos são limitadas a um
    workspace específico por workspaceId. A verificação de integridade não
    inclui um workspace no caminho.
  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: Servidor de produção
security: []
paths:
  /bridge/api/v1/workspaces/{workspaceId}/contacts/lookup:
    get:
      tags:
        - Contacts API
      summary: Obter contato por um identificador
      description: >-
        Obtém um contato específico por qualquer um de seus identificadores no
        workspace.


        `type=ID` retorna o mesmo contato que GET /contacts/{contactId}, a URL
        canônica de um contato e a opção preferida quando você já tem seu ID.
      operationId: >-
        retrieve_contact_by_identifier_bridge_api_v1_workspaces__workspaceId__contacts_lookup_get
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            format: uuid
            description: Identificador único do workspace (UUID v4).
            examples:
              - b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234
            title: Workspaceid
          description: Identificador único do workspace (UUID v4).
        - name: type
          in: query
          required: true
          schema:
            $ref: '#/components/schemas/ParticipantIdentifierType'
            description: Tipo de identificador usado para informar o valor.
          description: Tipo de identificador usado para informar o valor.
        - name: value
          in: query
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 320
            description: >-
              O identificador no formato indicado por `type`. Um `PHONE` é
              interpretado como o celular ao gravar um contato: sem código de
              país, usa-se o país padrão do workspace, ignorando espaços e
              separadores. Em um `EMAIL`, o domínio é convertido para
              minúsculas, mas a parte local deve corresponder exatamente ao
              valor enviado.
            title: Value
          description: >-
            O identificador no formato indicado por `type`. Um `PHONE` é
            interpretado como o celular ao gravar um contato: sem código de
            país, usa-se o país padrão do workspace, ignorando espaços e
            separadores. Em um `EMAIL`, o domínio é convertido para minúsculas,
            mas a parte local deve corresponder exatamente ao valor enviado.
          examples:
            cellphone:
              summary: A cellphone
              description: >-
                Send with `type=PHONE`. A value that cannot be read as a
                cellphone is refused before any lookup happens.
              value: '+14084029292'
            email:
              summary: An email address
              description: >-
                Send with `type=EMAIL`. `John.Doe@example.com` and
                `john.doe@example.com` are different identifiers and do not
                resolve to the same contact.
              value: john.doe@example.com
            id:
              summary: The contact id
              description: >-
                Send with `type=ID`. Returns exactly what `GET
                /contacts/{contactId}` returns, which stays the canonical URL
                for a contact.
              value: 4e362e2b-67b2-4a7e-a9df-e9ecf9141be8
      responses:
        '200':
          description: Resposta bem-sucedida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactResponse'
        '403':
          description: Acesso proibido
          content:
            application/json:
              examples:
                FORBIDDEN:
                  value:
                    title: Forbidden
                    status: 403
                    code: BRIDGE_CORE_0301
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: Não encontrado
          content:
            application/json:
              examples:
                WORKSPACE_NOT_FOUND:
                  value:
                    title: Workspace Not Found
                    status: 404
                    code: BRIDGE_WORKSPACE_0001
                EXTERNAL_USER_NOT_FOUND:
                  value:
                    title: External User Not Found
                    status: 404
                    code: BRIDGE_EXTERNAL_0001
              schema:
                $ref: '#/components/schemas/Problem'
        '422':
          description: Conteúdo não processável
          content:
            application/json:
              examples:
                INVALID_FIELD_FORMAT:
                  value:
                    title: Invalid Field Format
                    status: 422
                    code: BRIDGE_CORE_0101
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: Muitas solicitações
          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:
    ParticipantIdentifierType:
      type: string
      enum:
        - ID
        - EMAIL
        - PHONE
      title: ParticipantIdentifierType
    ContactResponse:
      properties:
        id:
          type: string
          title: Identifier
          description: Identificador único do contato (UUID v4).
          examples:
            - b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234
        workspaceId:
          type: string
          title: Workspace Identifier
          description: Identificador único do workspace ao qual este contato pertence
          examples:
            - 92b2d4f3-81e1-4b61-a7ec-6f4ff3b58be5
        type:
          $ref: '#/components/schemas/ExternalUserType'
          title: Contact Type
          description: >-
            NORMAL quando todos os campos obrigatórios de identidade e atributos
            personalizados estão presentes; PARTIAL caso contrário.
          examples:
            - NORMAL
            - PARTIAL
        firstName:
          anyOf:
            - type: string
            - type: 'null'
          title: First Name
          description: Nome do contato.
          examples:
            - John
            - null
        lastName:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Name
          description: Sobrenome do contato.
          examples:
            - Doe
            - null
        email:
          anyOf:
            - type: string
              format: email
            - type: 'null'
          title: Email
          description: E-mail do contato.
          examples:
            - john.doe@example.com
            - null
        cellphone:
          anyOf:
            - type: string
              format: phone
            - type: 'null'
          title: Cellphone
          description: Número de celular do contato.
          examples:
            - '+14084029292'
            - null
        customAttributes:
          items:
            $ref: '#/components/schemas/CustomAttributeResponse'
          type: array
          title: Custom Attributes
          description: Lista de atributos personalizados de chave e valor.
        languageCode:
          anyOf:
            - $ref: '#/components/schemas/LanguageCode'
            - type: 'null'
          title: Language Code
          description: Código de idioma do usuário externo.
          examples:
            - EN
            - null
        ownerId:
          anyOf:
            - type: string
            - type: 'null'
          title: Owner Identifier
          description: >-
            ID do Bridge User proprietário do contato. Resolva-o com `GET
            /users/{userId}`.
          examples:
            - 37673840-6259-40f9-bbe5-a7db40f8e3cf
            - null
        createdAt:
          type: string
          title: Created At
          description: Data e hora de criação do contato.
          examples:
            - '2003-04-10T08:00:00.000Z'
        updatedAt:
          type: string
          title: Updated At
          description: Data e hora da última atualização do contato.
          examples:
            - '2003-04-10T08:00:00.000Z'
      type: object
      required:
        - id
        - workspaceId
        - type
        - createdAt
        - updatedAt
      title: ContactResponse
      description: Corpo da resposta para operações com contatos.
    Problem:
      properties:
        title:
          type: string
          title: Title
          description: Resumo breve do tipo de problema.
        status:
          type: integer
          title: Status
          description: >-
            Código de status HTTP gerado pelo servidor de origem para esta
            ocorrência do problema.
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
          description: Explicação específica desta ocorrência do problema.
        instance:
          anyOf:
            - type: string
            - type: 'null'
          title: Instance
          description: Referência URI que identifica esta ocorrência do problema.
        traceId:
          anyOf:
            - type: string
            - type: 'null'
          title: Traceid
          description: ID de rastreamento para depuração.
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
          description: >-
            Código para identificar o erro; consulte a página de códigos de erro
            para mais detalhes.
        errors:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          title: Errors
          description: Lista de detalhes dos erros.
        extra:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Extra
          description: Informações adicionais sobre o problema.
      type: object
      required:
        - title
        - status
      title: Problem
      description: Objeto que representa o corpo de uma resposta Problem.
    ExternalUserType:
      type: string
      enum:
        - PARTIAL
        - NORMAL
      title: ExternalUserType
    CustomAttributeResponse:
      properties:
        key:
          type: string
          title: Key
          description: Chave ou nome do atributo
        values:
          items:
            type: string
          type: array
          title: Values
          description: Valor do atributo
      type: object
      required:
        - key
      title: CustomAttributeResponse
      description: >-
        Corpo da resposta para atributos personalizados em operações com
        contatos.
    LanguageCode:
      type: string
      enum:
        - ES
        - EN
        - AF
        - SQ
        - AR
        - AZ
        - BN
        - BG
        - CA
        - ZH_CN
        - HR
        - CS
        - DA
        - NL
        - ET
        - FIL
        - FI
        - FR
        - KA
        - DE
        - EL
        - GU
        - HA
        - HE
        - HI
        - HU
        - ID
        - GA
        - IT
        - JA
        - KN
        - KK
        - RW_RW
        - KO
        - KY_KG
        - LO
        - LV
        - LT
        - MK
        - MS
        - ML
        - MR
        - NB
        - FA
        - PL
        - PT_BR
        - PA
        - RO
        - RU
        - SR
        - SK
        - SL
        - SW
        - SV
        - TA
        - TE
        - TH
        - TR
        - UK
        - UR
        - UZ
        - VI
        - ZU
      title: LanguageCode
  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.