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

# Leia todas as páginas de resultados

> Percorra os cursores opacos de Contatos, conversas, usuários do Bridge e Agentes, sem parar em uma página com poucos registros.

Os endpoints de listagem retornam uma coleção e um `cursor` opcional. Envie esse cursor sem alterações para ler a próxima página. Continue seguindo os cursores até que o valor seja nulo ou esteja ausente.

## Escolha a coleção

Os quatro endpoints abaixo aceitam `limit` de **1 a 100**, com valor padrão **20**.

| Recurso | Caminho após o workspace | Campo da coleção |
| - | - | - |
| Contatos | `/contacts` | `contacts` |
| Conversas | `/conversations` | `conversations` |
| Usuários do Bridge | `/users` | `users` |
| Agentes | `/agents` | `agents` |

Use a [consulta de contatos](https://docs.bridge.new/pt-br/api-reference/contacts-api/obter-contato-por-um-identificador.md) ou a [consulta de usuários do Bridge](https://docs.bridge.new/pt-br/api-reference/internal-users-api/obter-usu%C3%A1rio-interno-por-um-identificador) quando precisar encontrar uma pessoa conhecida. Percorrer a lista inteira é uma tarefa diferente.

## Exemplo no servidor

Este exemplo lê Contatos. Salve como `list-contacts.mjs` e defina `BRIDGE_API_KEY` e `BRIDGE_WORKSPACE_ID` no servidor.

A proteção local `maxPages` evita uma execução ilimitada por engano; ela não é um limite da API Bridge. A proteção contra cursores repetidos interrompe a execução e informa o problema, em vez de retornar silenciosamente uma lista incompleta.

```javascript theme={null}
const BASE = "https://api-connect-us.bridge.new";
const apiKey = process.env.BRIDGE_API_KEY;
const workspaceId = process.env.BRIDGE_WORKSPACE_ID;
if (!apiKey || !workspaceId) {
  throw new Error("Set BRIDGE_API_KEY and BRIDGE_WORKSPACE_ID.");
}

async function* pages(resource, collection, filters = {}) {
  let cursor;
  const seen = new Set();
  const maxPages = 10000;

  for (let pageNumber = 0; pageNumber < maxPages; pageNumber += 1) {
    const url = new URL(
      `/bridge/api/v1/workspaces/${encodeURIComponent(workspaceId)}/${resource}`,
      BASE,
    );
    for (const [key, value] of Object.entries(filters)) {
      url.searchParams.set(key, String(value));
    }
    url.searchParams.set("limit", "100");
    if (cursor !== undefined) url.searchParams.set("cursor", cursor);

    const response = await fetch(url, { headers: { "x-api-key": apiKey } });
    const body = await response.json().catch(() => null);
    if (response.status !== 200) {
      const code = body?.code ? ` (${body.code})` : "";
      throw new Error(`List ${resource}: HTTP ${response.status}${code}`);
    }
    if (!Array.isArray(body?.[collection])) {
      throw new Error(`Expected the ${collection} collection.`);
    }

    yield body[collection];
    if (body.cursor === null || body.cursor === undefined) return;
    if (typeof body.cursor !== "string" || seen.has(body.cursor)) {
      throw new Error("Invalid or repeated cursor; stopped without claiming completion.");
    }
    seen.add(body.cursor);
    cursor = body.cursor;
  }
  throw new Error("Local page guard reached; the sweep is incomplete.");
}

let count = 0;
for await (const contacts of pages("contacts", "contacts")) {
  // Process or store this page before continuing. Avoid logging personal data.
  count += contacts.length;
}
console.log({ contactsRead: count });
```

```bash theme={null}
node list-contacts.mjs
```

Use `pages("conversations", "conversations", { status: "ACTIVE" })`, `pages("users", "users")` ou `pages("agents", "agents")` com o contrato correspondente. Mantenha os mesmos filtros durante todo o percurso.

## Não pare em uma página com poucos registros

Uma página com menos registros que `limit` ainda pode ter uma próxima página. O endpoint de Agentes documenta esse comportamento explicitamente. O sinal de continuação é o cursor retornado, não o tamanho da coleção.

Trate o cursor como opaco. Não o decodifique, incremente ou crie por conta própria. O `URL.searchParams` do exemplo preserva seu valor por meio da codificação de URL.

## Filtros e limites de requisições

* Os filtros `ownerEmail` e `search` da lista de Contatos estão obsoletos. Para um e-mail ou telefone conhecido, use a consulta de contatos. Para filtrar um conjunto por `ownerId`, leia esse campo nas linhas retornadas e faça a filtragem no seu código.
* Os filtros `email` e `status` da lista de usuários do Bridge estão obsoletos. Use a consulta para um e-mail conhecido ou examine o `status` de cada usuário retornado.
* Cada requisição de página consome a cota compartilhada do workspace. Siga o guia de [limites de requisições](https://docs.bridge.new/pt-br/rate-limits.md), incluindo `Retry-After` em respostas `429`. Este exemplo mínimo para em respostas diferentes de 200, sem tentar novamente automaticamente.

Os contratos publicados não garantem uma visão transacionalmente consistente da lista enquanto os registros estão mudando. Não apresente esse percurso como uma exportação necessariamente consistente nem presuma um prazo de validade do cursor que não esteja documentado.

## Referências

* [Listar Contatos](https://docs.bridge.new/pt-br/api-reference/contacts-api/listar-contatos.md)
* [Listar conversas](https://docs.bridge.new/pt-br/api-reference/conversations-api/consultar-conversas-com-filtros-flex%C3%ADveis)
* [Listar usuários do Bridge](https://docs.bridge.new/pt-br/api-reference/internal-users-api/listar-usu%C3%A1rios-internos)
* [Listar Agentes](https://docs.bridge.new/pt-br/api-reference/agents-api/listar-os-agents-de-um-workspace.md)
* [Respostas e erros](https://docs.bridge.new/pt-br/guides/responses.md)


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