---
title: "Get Workspace Auth Connections"
method: GET
path: "/v1/workspace/auth-connections"
tags: ["workspace"]
---

# Get Workspace Auth Connections

`GET /v1/workspace/auth-connections`

Get all auth connections for the workspace

## Headers

- `xi-api-key` string, nullable — Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

## Response `200`

Successful Response

- ListAuthConnectionsResponse
  - `auth_connections` union[], required
    - union — The type of auth connection config
      - OAuth2ClientCredsResponse — Response model for oauth2 client creds
        - `name` string, required
        - `auth_type` 'oauth2_client_credentials'
        - `provider` string, required
        - `client_id` string, required
        - `token_url` string, required
        - `scopes` string[]
        - `extra_params` object
        - `basic_auth_in_header` boolean — If True, send client credentials in Authorization header as Basic Auth instead of request body
        - `id` string, required
        - `used_by` AuthConnectionDependencies — Dependencies that use an auth connection
          - `tools` union[]
            - union
              - …
          - `mcp_servers` union[]
            - union
              - …
          - `integration_connections` DependentIntegrationConnectionIdentifier[]
            - `id` string, required
            - `name` string, required
        - `status` 'active' | 'refresh_failed' | 'revoked' | 'credential_invalid' — Single status field shared by every auth type's stored credential. OAuth values (``REFRESH_FAILED``, ``REVOKED``) are written by the OAuth token-manager refresh path. ``CREDENTIAL_INVALID`` is written by the tool execution path when an upstream response matches a credential's ``failure_signatures`` entry (Bearer, Basic auth, etc.).
        - `status_detail` string, nullable
        - `status_updated_at` string, nullable
        - `custom_headers` object — Custom headers configured for OAuth2 token requests
      - RefreshTokenAuthResponse — Response model for OAuth2 refresh-token-grant auth connections
        - `name` string, required
        - `auth_type` 'refresh_token_auth'
        - `provider` string, required
        - `client_id` string, required
        - `token_url` string, required
        - `scopes` string[]
        - `extra_params` object
        - `id` string, required
        - `used_by` AuthConnectionDependencies — Dependencies that use an auth connection
          - `tools` union[]
            - union
              - …
          - `mcp_servers` union[]
            - union
              - …
          - `integration_connections` DependentIntegrationConnectionIdentifier[]
            - `id` string, required
            - `name` string, required
        - `status` 'active' | 'refresh_failed' | 'revoked' | 'credential_invalid' — Single status field shared by every auth type's stored credential. OAuth values (``REFRESH_FAILED``, ``REVOKED``) are written by the OAuth token-manager refresh path. ``CREDENTIAL_INVALID`` is written by the tool execution path when an upstream response matches a credential's ``failure_signatures`` entry (Bearer, Basic auth, etc.).
        - `status_detail` string, nullable
        - `status_updated_at` string, nullable
      - BasicAuthResponse — Response model for basic auth
        - `name` string, required
        - `auth_type` 'basic_auth'
        - `provider` string, required
        - `username` string, required
        - `id` string, required
        - `used_by` AuthConnectionDependencies — Dependencies that use an auth connection
          - `tools` union[]
            - union
              - …
          - `mcp_servers` union[]
            - union
              - …
          - `integration_connections` DependentIntegrationConnectionIdentifier[]
            - `id` string, required
            - `name` string, required
        - `status` 'active' | 'refresh_failed' | 'revoked' | 'credential_invalid' — Single status field shared by every auth type's stored credential. OAuth values (``REFRESH_FAILED``, ``REVOKED``) are written by the OAuth token-manager refresh path. ``CREDENTIAL_INVALID`` is written by the tool execution path when an upstream response matches a credential's ``failure_signatures`` entry (Bearer, Basic auth, etc.).
        - `status_detail` string, nullable
        - `status_updated_at` string, nullable
      - BearerAuthResponse — Response model for bearer auth
        - `name` string, required
        - `auth_type` 'bearer_auth'
        - `provider` string, required
        - `id` string, required
        - `used_by` AuthConnectionDependencies — Dependencies that use an auth connection
          - `tools` union[]
            - union
              - …
          - `mcp_servers` union[]
            - union
              - …
          - `integration_connections` DependentIntegrationConnectionIdentifier[]
            - `id` string, required
            - `name` string, required
        - `status` 'active' | 'refresh_failed' | 'revoked' | 'credential_invalid' — Single status field shared by every auth type's stored credential. OAuth values (``REFRESH_FAILED``, ``REVOKED``) are written by the OAuth token-manager refresh path. ``CREDENTIAL_INVALID`` is written by the tool execution path when an upstream response matches a credential's ``failure_signatures`` entry (Bearer, Basic auth, etc.).
        - `status_detail` string, nullable
        - `status_updated_at` string, nullable
      - OAuth2JWTResponse — Response model for OAuth2 JWT auth connections
        - `name` string, required
        - `auth_type` 'oauth2_jwt'
        - `provider` string, required
        - `algorithm` 'HS256' | 'HS384' | 'HS512' | 'RS256' | 'RS384' | 'RS512' — JWT signing algorithm
        - `key_id` string, nullable — Key ID (kid) for JWT header - useful for key rotation
        - `issuer` string, required — JWT issuer (iss claim)
        - `audience` string, required — JWT audience (aud claim)
        - `subject` string, required — JWT subject (sub claim)
        - `expiration_seconds` integer — Token expiration time in seconds
        - `extra_params` object — Additional custom claims to include in the JWT
        - `token_url` string, required — Token endpoint URL for exchanging JWT for access token
        - `scopes` string[] — OAuth2 scopes to request when exchanging JWT for access token
        - `token_response_field` 'access_token' | 'id_token' — Token field to extract from the token endpoint response.
        - `id` string, required
        - `used_by` AuthConnectionDependencies — Dependencies that use an auth connection
          - `tools` union[]
            - union
              - …
          - `mcp_servers` union[]
            - union
              - …
          - `integration_connections` DependentIntegrationConnectionIdentifier[]
            - `id` string, required
            - `name` string, required
        - `status` 'active' | 'refresh_failed' | 'revoked' | 'credential_invalid' — Single status field shared by every auth type's stored credential. OAuth values (``REFRESH_FAILED``, ``REVOKED``) are written by the OAuth token-manager refresh path. ``CREDENTIAL_INVALID`` is written by the tool execution path when an upstream response matches a credential's ``failure_signatures`` entry (Bearer, Basic auth, etc.).
        - `status_detail` string, nullable
        - `status_updated_at` string, nullable
      - PrivateKeyJWTResponse — Response model for Private Key JWT auth connections
        - `name` string, required
        - `auth_type` 'private_key_jwt'
        - `provider` string, required
        - `algorithm` 'HS256' | 'HS384' | 'HS512' | 'RS256' | 'RS384' | 'RS512' — JWT signing algorithm
        - `key_id` string, nullable — Key ID (kid) for JWT header - useful for key rotation
        - `issuer` string, required — JWT issuer (iss claim)
        - `audience` string, required — JWT audience (aud claim)
        - `subject` string, required — JWT subject (sub claim)
        - `expiration_seconds` integer — Token expiration time in seconds
        - `extra_params` object — Additional custom claims to include in the JWT
        - `id` string, required
        - `used_by` AuthConnectionDependencies — Dependencies that use an auth connection
          - `tools` union[]
            - union
              - …
          - `mcp_servers` union[]
            - union
              - …
          - `integration_connections` DependentIntegrationConnectionIdentifier[]
            - `id` string, required
            - `name` string, required
        - `status` 'active' | 'refresh_failed' | 'revoked' | 'credential_invalid' — Single status field shared by every auth type's stored credential. OAuth values (``REFRESH_FAILED``, ``REVOKED``) are written by the OAuth token-manager refresh path. ``CREDENTIAL_INVALID`` is written by the tool execution path when an upstream response matches a credential's ``failure_signatures`` entry (Bearer, Basic auth, etc.).
        - `status_detail` string, nullable
        - `status_updated_at` string, nullable
      - MTLSAuthResponse — Response model for mTLS auth connections.
        - `name` string, required
        - `auth_type` 'mtls'
        - `provider` string, required
        - `id` string, required
        - `used_by` AuthConnectionDependencies — Dependencies that use an auth connection
          - `tools` union[]
            - union
              - …
          - `mcp_servers` union[]
            - union
              - …
          - `integration_connections` DependentIntegrationConnectionIdentifier[]
            - `id` string, required
            - `name` string, required
        - `status` 'active' | 'refresh_failed' | 'revoked' | 'credential_invalid' — Single status field shared by every auth type's stored credential. OAuth values (``REFRESH_FAILED``, ``REVOKED``) are written by the OAuth token-manager refresh path. ``CREDENTIAL_INVALID`` is written by the tool execution path when an upstream response matches a credential's ``failure_signatures`` entry (Bearer, Basic auth, etc.).
        - `status_detail` string, nullable
        - `status_updated_at` string, nullable
      - CustomHeaderAuthResponse — Response model for Custom Header Auth auth connections
        - `name` string, required
        - `auth_type` 'custom_header_auth'
        - `provider` string, required
        - `header_name` string, required — The name of the header to use for authentication (e.g., 'x-api-key')
        - `id` string, required
        - `used_by` AuthConnectionDependencies — Dependencies that use an auth connection
          - `tools` union[]
            - union
              - …
          - `mcp_servers` union[]
            - union
              - …
          - `integration_connections` DependentIntegrationConnectionIdentifier[]
            - `id` string, required
            - `name` string, required
        - `status` 'active' | 'refresh_failed' | 'revoked' | 'credential_invalid' — Single status field shared by every auth type's stored credential. OAuth values (``REFRESH_FAILED``, ``REVOKED``) are written by the OAuth token-manager refresh path. ``CREDENTIAL_INVALID`` is written by the tool execution path when an upstream response matches a credential's ``failure_signatures`` entry (Bearer, Basic auth, etc.).
        - `status_detail` string, nullable
        - `status_updated_at` string, nullable
      - ApiIntegrationOAuth2AuthCodeResponse — Response model for integration-managed OAuth2 Auth Code auth connections
        - `name` string, required
        - `auth_type` 'api_integration_oauth2_auth_code'
        - `provider` string, required
        - `token_url` string, required
        - `scopes` string[]
        - `scope_separator` ' ' | ',' — Separator for scopes
        - `expires_at` string, required — ISO 8601 timestamp of when the access token expires
        - `integration_id` string, required
        - `credential_id` string, required
        - `id` string, required
        - `used_by` AuthConnectionDependencies — Dependencies that use an auth connection
          - `tools` union[]
            - union
              - …
          - `mcp_servers` union[]
            - union
              - …
          - `integration_connections` DependentIntegrationConnectionIdentifier[]
            - `id` string, required
            - `name` string, required
        - `status` 'active' | 'refresh_failed' | 'revoked' | 'credential_invalid' — Single status field shared by every auth type's stored credential. OAuth values (``REFRESH_FAILED``, ``REVOKED``) are written by the OAuth token-manager refresh path. ``CREDENTIAL_INVALID`` is written by the tool execution path when an upstream response matches a credential's ``failure_signatures`` entry (Bearer, Basic auth, etc.).
        - `status_detail` string, nullable
        - `status_updated_at` string, nullable
      - ApiIntegrationOAuth2CustomAppResponse — Response model for user-owned OAuth2 Custom App auth connections
        - `name` string, required
        - `auth_type` 'api_integration_oauth2_custom_app'
        - `provider` string, required
        - `token_url` string, required
        - `scopes` string[]
        - `scope_separator` ' ' | ',' — Separator for scopes
        - `expires_at` string, required — ISO 8601 timestamp of when the access token expires
        - `integration_id` string, required
        - `credential_id` string, required
        - `client_id` string, required — OAuth client ID (rendered from template if credential uses templated credentials, None for legacy connections)
        - `id` string, required
        - `used_by` AuthConnectionDependencies — Dependencies that use an auth connection
          - `tools` union[]
            - union
              - …
          - `mcp_servers` union[]
            - union
              - …
          - `integration_connections` DependentIntegrationConnectionIdentifier[]
            - `id` string, required
            - `name` string, required
        - `status` 'active' | 'refresh_failed' | 'revoked' | 'credential_invalid' — Single status field shared by every auth type's stored credential. OAuth values (``REFRESH_FAILED``, ``REVOKED``) are written by the OAuth token-manager refresh path. ``CREDENTIAL_INVALID`` is written by the tool execution path when an upstream response matches a credential's ``failure_signatures`` entry (Bearer, Basic auth, etc.).
        - `status_detail` string, nullable
        - `status_updated_at` string, nullable
      - WhatsAppAuthResponse
        - `name` string, required
        - `auth_type` 'whatsapp_auth'
        - `provider` 'whatsapp'
        - `phone_number_id` string, required
        - `id` string, required
        - `used_by` AuthConnectionDependencies — Dependencies that use an auth connection
          - `tools` union[]
            - union
              - …
          - `mcp_servers` union[]
            - union
              - …
          - `integration_connections` DependentIntegrationConnectionIdentifier[]
            - `id` string, required
            - `name` string, required
        - `status` 'active' | 'refresh_failed' | 'revoked' | 'credential_invalid' — Single status field shared by every auth type's stored credential. OAuth values (``REFRESH_FAILED``, ``REVOKED``) are written by the OAuth token-manager refresh path. ``CREDENTIAL_INVALID`` is written by the tool execution path when an upstream response matches a credential's ``failure_signatures`` entry (Bearer, Basic auth, etc.).
        - `status_detail` string, nullable
        - `status_updated_at` string, nullable
      - SlackBotAuthResponse — Response model for the internal Slack BYO bot auth connection.
        - `name` string, required
        - `auth_type` 'slack_bot_auth'
        - `provider` 'Slack'
        - `id` string, required
        - `used_by` AuthConnectionDependencies — Dependencies that use an auth connection
          - `tools` union[]
            - union
              - …
          - `mcp_servers` union[]
            - union
              - …
          - `integration_connections` DependentIntegrationConnectionIdentifier[]
            - `id` string, required
            - `name` string, required
        - `status` 'active' | 'refresh_failed' | 'revoked' | 'credential_invalid' — Single status field shared by every auth type's stored credential. OAuth values (``REFRESH_FAILED``, ``REVOKED``) are written by the OAuth token-manager refresh path. ``CREDENTIAL_INVALID`` is written by the tool execution path when an upstream response matches a credential's ``failure_signatures`` entry (Bearer, Basic auth, etc.).
        - `status_detail` string, nullable
        - `status_updated_at` string, nullable
      - UrlSecretAuthResponse
        - `name` string, required
        - `auth_type` 'url_secret'
        - `provider` string, required
        - `id` string, required
        - `used_by` AuthConnectionDependencies — Dependencies that use an auth connection
          - `tools` union[]
            - union
              - …
          - `mcp_servers` union[]
            - union
              - …
          - `integration_connections` DependentIntegrationConnectionIdentifier[]
            - `id` string, required
            - `name` string, required
        - `status` 'active' | 'refresh_failed' | 'revoked' | 'credential_invalid' — Single status field shared by every auth type's stored credential. OAuth values (``REFRESH_FAILED``, ``REVOKED``) are written by the OAuth token-manager refresh path. ``CREDENTIAL_INVALID`` is written by the tool execution path when an upstream response matches a credential's ``failure_signatures`` entry (Bearer, Basic auth, etc.).
        - `status_detail` string, nullable
        - `status_updated_at` string, nullable

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/elevenlabs/apis/elevenlabs-api-documentation.md) · [All operations](https://skmtc.net/elevenlabs/apis/elevenlabs-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/elevenlabs/elevenlabs-api-documentation/versions/e77a0a530a82/schema)