---
title: "List agent connectors"
method: GET
path: "/v2/agents/{agent_key}/connectors"
tags: ["Agent Connectors"]
---

# List agent connectors

`GET /v2/agents/{agent_key}/connectors`

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

## Path parameters

- `agent_key` string, required — A unique key that identifies an agent.

## Query parameters

- `type` 'slack' | 'gchat' | 'zoom' | 'widget'
- `enabled` boolean
- `limit` integer
- `page_key` string

## Headers

- `Request-Timeout` integer
- `Request-Timeout-Millis` integer

## Response `200`

List of available connectors for the agent.

- ListAgentConnectorsResponse — Response containing a list of agent connectors.
  - `connectors` AgentConnector[], required — List of agent connectors.
    - `id` string, required — The unique identifier for the connector.
    - `agent_key` string, required — A unique key that identifies an agent.
    - `name` string, required — The human-readable name of the connector.
    - `description` string — A detailed description of what this connector does.
    - `type` 'slack' | 'gchat' | 'zoom' | 'widget', required — The type of connector.
    - `status` 'active' | 'inactive' | 'error', required — The current status of the connector.
    - `status_message` string — Detailed status message (e.g., error description or success confirmation).
    - `metadata` object — Arbitrary metadata associated with the connector.
    - `enabled` boolean, required — Whether the connector is currently enabled and can receive events.
    - `configuration` union, required — Read view of a connector's configuration, as returned by GET and list endpoints. Contains the secrets supplied at create time alongside platform-derived display fields: - Slack exposes `webhook_path` - gchat exposes `audience_url` and `client_email` - zoom exposes the generated `connector_token` and `webhook_path` - widget exposes `bootstrap_path`
      - object — Properties shared by every connector configuration read view.
        - `hidden_output_types` AgentOutputType[] — Agent output types omitted from the connector's channel; the final response is always posted.
        - `type` string, required — The type of connector configuration.
        - `bot_token` string, required — Slack bot token (xoxb-) for API access. Encrypted at rest.
        - `signing_secret` string, required — Slack signing secret for webhook verification. Encrypted at rest.
        - `api_app_id` string, required — The Slack App ID that matches inbound webhook events to this connector.
        - `webhook_path` string, required — The webhook path for this Slack connector to receive events.
        - `respond_to_thread_replies` boolean — When true, the agent responds to follow-up replies in any thread it has already replied in or started, without requiring a new @-mention. Starting a new thread still requires an @-mention.
      - object — Properties shared by every connector configuration read view.
        - `hidden_output_types` AgentOutputType[] — Agent output types omitted from the connector's channel; the final response is always posted.
        - `type` string, required — The type of connector configuration.
        - `audience_url` string, required — The webhook URL for this connector. Set the Chat app's HTTP endpoint URL and Authentication audience fields to this value in the Google Cloud console. Inbound Google Chat ID tokens are accepted only if aud equals this URL. This value contains a secret and is encrypted at rest.
        - `client_email` string, required — Service account email derived from the service account key.
        - `project_id` string, required — Google Cloud project id derived from the service account key. This is the project that hosts the Chat app, so clients can use it to deep-link into the app's Google Chat configuration.
      - object — Properties shared by every connector configuration read view.
        - `hidden_output_types` AgentOutputType[] — Agent output types omitted from the connector's channel; the final response is always posted.
        - `type` string, required — The type of connector configuration.
        - `connector_token` string, required — Platform-generated shared secret that authenticates inbound webhook requests. Zoom Contact Center must send this value in the `x-zoom-connector-token` header. Generated at create time, preserved across configuration updates, and encrypted at rest.
        - `callback_url` string, required — The Zoom-provided URL the agent's reply is POSTed to once it is ready. Always an absolute https URL.
        - `callback_access_token` string — Optional access token issued by Zoom for the callback URL. When set, reply POSTs carry it as a bearer Authorization header. Encrypted at rest.
        - `typing_duration_seconds` integer, required — How long the typing indicator returned by the webhook runs while the agent works on its reply.
        - `webhook_path` string, required — The inbound webhook path for this connector. Configure the Zoom Contact Center bot endpoint URL to this path on the Vectara API host.
      - object — Properties shared by every connector configuration read view.
        - `hidden_output_types` AgentOutputType[] — Agent output types omitted from the connector's channel; the final response is always posted.
        - `type` string, required — The type of connector configuration.
        - `public_access` boolean, required — Whether the widget admits anonymous visitors. Gated alongside the connector's `enabled`: the widget admits anonymous visitors only while both are `true`. Independent of `status`. While `false`, the widget bootstrap endpoint still serves the connector's presentation but mints no anonymous visitor id, and every previously minted visitor id is refused on the end-user session surface.
        - `alias_key` string, required — The platform-generated key of the alias fronting a widget connector, as reported in the connector's `alias_key` and `bootstrap_path`. Always `als_`-prefixed; the prefix is reserved, so no operator-chosen alias ever matches it.
        - `presentation` WidgetPresentation, required — The presentation configuration the widget client renders — branding, palette, welcome content, suggested prompts. Free-form apart from the required `version`; the platform stores it verbatim, serves it back uninterpreted, and caps its total size. Null-valued keys are accepted but are omitted from responses. Served to anonymous visitors by the unauthenticated widget bootstrap endpoint, so widget clients must treat every value as untrusted data. Schema validation of the payload lands with the first Altera release; `version` is what lets clients render older payloads once the shape evolves.
          - `version` string, required — The version of the presentation payload's shape, chosen by the writer and echoed verbatim on read. Until the first Altera release the only accepted value is `beta`, marking the payload as free-form; schema-validated numbered versions arrive with that release.
        - `session_tti_minutes` integer — How long a session created through this widget may sit idle before it is closed, in minutes. Applied to every session created through this widget's alias, anonymous or signed-in, and reported as `tti_minutes` on those sessions. Set to 0 for sessions that never expire. Omit to use the platform default of 30 days.
        - `revealed_output_types` AgentOutputType[] — Agent output types included in the widget's end-user event projection; the final response is always visible. Applies to every session created through this widget's alias, anonymous or signed-in. Omitted or empty reveals none.
        - `session_metadata` object — Written as the `metadata` of every session created through this widget's alias, anonymous or signed-in. Readable wherever session metadata is readable: instruction templates, `run_condition`, `session_enrichment` references, alias routing rules, and tool `argument_override` expressions. Not served by the widget bootstrap endpoint and not returned on the end-user session object, though values reach the agent's context and may surface in its replies. Omitted or empty writes no session metadata.
        - `end_user_sign_in` WidgetSignIn — Enables the widget's sign-in affordance and names the identity provider it authenticates users against. The host page supplies a token minted by the referenced trusted token issuer, and the widget presents it as the bearer credential on end-user session requests. The platform verifies the token by its `iss` claim against the globally-unique issuer registration — never against this connector — so the token stands on its own: it signs the caller in as an end user across the customer's aliases, not this widget's alone. The platform accepts the token when its signature verifies against the issuer's JWKS and it carries an `email` claim. The referenced registration must exist, or the connector write is rejected with `400`.
          - `trusted_token_issuer_id` string, required — The unique identifier of a trusted token issuer.
        - `bootstrap_path` string, required — The unauthenticated bootstrap path the embed snippet calls to obtain a visitor id and the presentation configuration.
    - `created_at` string, date-time, required — Timestamp when the connector was created.
    - `updated_at` string, date-time — Timestamp when the connector was last updated.
    - `last_webhook_at` string, date-time — Timestamp of the most recently received inbound webhook for this connector, regardless of outcome. Absent until the first webhook arrives.
    - `last_webhook_status` 'success' | 'jwt_verification_failed' | 'audience_mismatch' | 'auth_failed' | 'missing_signature' | 'missing_engagement' | 'event_parse_failed' | 'internal_error' | 'unknown' — Outcome of the most recently received inbound webhook. Absent until the first webhook arrives. Values: - `success`: the webhook verified and the event was accepted. - `jwt_verification_failed`: the bearer token was missing or could not be verified. - `audience_mismatch`: the token was valid but its aud did not equal the connector's audience_url. - `auth_failed`: the inbound request lacked or did not match the connector's authentication secret. - `missing_signature`: the request lacked the signature needed for an asynchronous reply. - `missing_engagement`: the request lacked the engagement identifier needed to route the session. - `event_parse_failed`: the event body could not be parsed. - `internal_error`: an unexpected error occurred after the connector was resolved. - `unknown`: the outcome could not be classified.
  - `metadata` ListMetadata, required — The standard metadata in the response of a list operation.
    - `page_key` string — The page key for the next page of results. Pass it as a query parameter to request the next page.

## Other responses

- `403` — Permissions do not allow listing connectors for this agent.
- `404` — Agent not found.

## Changes

- **2026-09-04** `05ae305c8d84` — 1 breaking, 16 info
  - the `connectors/items/` response's property type changed from no type to `object` for status `200`
  - added the optional property `connectors/items/description` to the response with the `200` status
  - added the optional property `connectors/items/last_webhook_at` to the response with the `200` status
  - added the optional property `connectors/items/last_webhook_status` to the response with the `200` status
  - …13 more
- …earlier changes not shown

[Full history](https://skmtc.dev/vectara/apis/vectara-rest-api-v2/changes/v2/agents/:agent_key/connectors/get.md)

---

[API](https://skmtc.dev/vectara/apis/vectara-rest-api-v2.md) · [All operations](https://skmtc.dev/vectara/apis/vectara-rest-api-v2/llms.txt) · [OpenAPI document](https://skmtc.dev/vectara/apis/vectara-rest-api-v2/revisions/c94fd099d78b?raw)