v3

latestOpenAPI 3.0.02026-08-081996601.2 MB

Agent Connectors

List agent connectors

Lists all connectors for an agent, with optional filtering and pagination.

get/v2/agents/{agent_key}/connectors

Path parameters

agent_keystring required

A unique key that identifies an agent.

Example:customer_support

The unique identifier of the agent to list connectors for.

Query parameters

type'slack' | 'gchat' | 'zoom'

Example:slack

Filter connectors by type.

enabledboolean

Example:true

Filter connectors by enabled status.

limitinteger

The maximum number of connectors to return in the list.

page_keystring

The opaque cursor returned in metadata.page_key of the previous response. Omit it to fetch the first page.

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Response

List of available connectors for the agent.

Example response

{
  "connectors": [
    {
      "id": "con_3Kx9QpVn2mZr8YbLc5TdWe",
      "agent_key": "customer_support",
      "name": "Customer Support Slack Channel",
      "description": "Receives customer support messages from the",
      "type": "slack",
      "status": "active",
      "status_message": "Slack authentication successful",
      "metadata": {
        "priority": "high",
        "department": "customer_service"
      },
      "enabled": true,
      "configuration": {
        "hidden_output_types": [
          "tool_calls"
        ],
        "type": "slack",
        "bot_token": "xoxb-1234567890-1234567890123-abcdefghijklmnopqrstuvwx",
        "signing_secret": "abcdef1234567890abcdef1234567890abcdef12",
        "api_app_id": "A1234567890",
        "webhook_path": "/v2/agents/customer_support/connectors/con_3Kx9QpVn2mZr8YbLc5TdWe/input"
      },
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-16T14:45:00Z",
      "last_webhook_at": "2024-01-16T14:45:00Z",
      "last_webhook_status": "success"
    }
  ],
  "metadata": {
    "page_key": "eyJvZmZzZXQiOjF9"
  }
}