> ## 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 Lead Capture 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 Lead Capture 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. > Integrations API error codes follow the BRIDGE__ format, for example BRIDGE_CONVERSATION_0001, and are listed on the error codes page. Lead Capture error codes follow a different format, BRIDGE.CAMPAIGN_LEADS., and are listed on the Lead Capture error reference. Never invent a code that is not listed on the page for its own surface. > This documentation covers the Integrations API, webhooks and Lead Capture only. It does not describe the Bridge web application or its internal APIs. # List the Agents of a workspace > List the workspace's Agents with their status, availability and lines. Every Agent is listed whatever its status; `available` tells whether it can start conversations. A page can hold fewer than `limit` items; keep paging while `cursor` is not null. ## OpenAPI ````yaml /api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/agents openapi: 3.1.0 info: title: Bridge API summary: Bridge API specification for chat system management. description: >- Bridge API specification including webhook receiver endpoints, Contact CRUD operations, and comprehensive chat system. This API includes: 1. Webhook Receiver API - for CRM clients to receive event notifications from Bridge 2. Contact CRUD API - for clients to manage contacts in Bridge 3. Conversations API - for managing conversations with flexible user identification and participant management 4. Messages API - for sending messages and files to a conversation 5. Files API - for managing files in a message 6. Custom attributes API - for consult custom attributes of an specific workspace **Multi-Tenant Architecture**: All operations are scoped to a specific workspace using workspaceId. 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}/agents: get: tags: - Agents API summary: List the Agents of a workspace description: >- List the workspace's Agents with their status, availability and lines. Every Agent is listed whatever its status; `available` tells whether it can start conversations. A page can hold fewer than `limit` items; keep paging while `cursor` is not null. operationId: list_agents_bridge_api_v1_workspaces__workspaceId__agents_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: type in: query required: false schema: anyOf: - $ref: '#/components/schemas/AgentType' - type: 'null' description: Only return Agents of this type. title: Type description: Only return Agents of this type. - name: limit in: query required: false schema: type: integer maximum: 100 minimum: 1 description: Number of Agents per page default: 20 title: Limit description: Number of Agents per page - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: Cursor provided on a previous request to get the next page title: Cursor description: Cursor provided on a previous request to get the next page responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AgentsResponseList' '400': description: Bad Request content: application/json: examples: INVALID_CURSOR: value: title: Invalid Cursor status: 400 code: BRIDGE_AI_AGENT_OUTBOUND_0007 schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/json: examples: FORBIDDEN: value: title: Forbidden status: 403 code: BRIDGE_CORE_0301 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: AgentType: type: string enum: - LEADSCOUT - SERVICE_AGENT title: AgentType description: Kinds of Agent exposed by the public API. AgentsResponseList: properties: agents: items: $ref: '#/components/schemas/AgentResponse' type: array title: Agents description: Array of Agents. cursor: anyOf: - type: string - type: 'null' title: Cursor description: Cursor to be sent on the next page request. Null on the last page. type: object required: - agents title: AgentsResponseList description: Response body for listing the Agents of a workspace. 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 AgentResponse: properties: id: type: string title: Agent Identifier description: Unique identifier of the Agent. name: type: string title: Name description: Name of the Agent. description: anyOf: - type: string - type: 'null' title: Description description: Description of the Agent. Always present; null when it has none. type: $ref: '#/components/schemas/AgentType' title: Type description: Kind of Agent. examples: - LEADSCOUT - SERVICE_AGENT brandId: anyOf: - type: string - type: 'null' title: Brand Identifier description: >- Brand the Agent belongs to. Always present; null when it is not scoped to a brand. status: $ref: '#/components/schemas/AgentConfigStatus' title: Status description: Configuration status of the Agent. examples: - DRAFT - COMPLETE available: type: boolean title: Available description: >- Whether the Agent can start conversations: its configuration is complete and it has a line. unavailableReason: anyOf: - type: string - type: 'null' title: Unavailable Reason description: >- Why the Agent is not available: `DRAFT` (configuration incomplete) or `NO_LINES` (no active line). Always present; null when it is available. examples: - DRAFT - NO_LINES lines: items: $ref: '#/components/schemas/AgentLine' type: array title: Lines description: Active WhatsApp lines the Agent answers on. Empty when it has none. type: object required: - id - name - type - status - available title: AgentResponse description: An Agent of the workspace with its status and availability. 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 AgentConfigStatus: type: string enum: - DRAFT - COMPLETE title: AgentConfigStatus AgentLine: properties: providerChannelId: type: string title: Provider Channel Identifier description: >- Identifier of the line (the same value `providerChannelId` takes on outbound operations). type: object required: - providerChannelId title: AgentLine description: WhatsApp line an Agent answers on. 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.