Composio

Composio Account Management API

The Account Management API from Composio — 2 operation(s) for account management.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.composio.dev/reference
📖
Documentation
https://docs.composio.dev/reference/api-reference/tools
📖
Documentation
https://docs.composio.dev/reference/api-reference/connected-accounts
📖
Documentation
https://docs.composio.dev/reference/api-reference/auth-configs
📖
Documentation
https://docs.composio.dev/reference/api-reference/triggers
📖
Documentation
https://docs.composio.dev/reference/api-reference/toolkits

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/composio/refs/heads/main/openapi/composio-account-management-api-openapi.yml

Other Resources

🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/composio/refs/heads/main/rules/composio-rules.yml
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/composio/refs/heads/main/apis.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/composio/refs/heads/main/arazzo/composio-connect-account-via-auth-config-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/composio/refs/heads/main/arazzo/composio-disable-active-trigger-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/composio/refs/heads/main/arazzo/composio-discover-and-execute-tool-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/composio/refs/heads/main/arazzo/composio-execute-tool-on-connected-account-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/composio/refs/heads/main/arazzo/composio-hosted-auth-link-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/composio/refs/heads/main/arazzo/composio-natural-language-tool-execution-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/composio/refs/heads/main/arazzo/composio-provision-mcp-server-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/composio/refs/heads/main/arazzo/composio-refresh-connected-account-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/composio/refs/heads/main/arazzo/composio-setup-trigger-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/composio/refs/heads/main/arazzo/composio-tool-router-connect-toolkit-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/composio/refs/heads/main/arazzo/composio-tool-router-session-workflow.yml

OpenAPI Specification

composio-account-management-api-openapi.yml Raw ↑ 
openapi: 3.0.0
info:
  version: 3.0.0
  title: Composio Platform Account Management API
  description: ''
  contact:
    name: Composio Support
    url: https://composio.dev/support
    email: support@composio.dev
  license:
    name: Proprietary
    url: https://composio.dev/terms
servers:
- url: https://backend.composio.dev
  description: PRODUCTION API
tags:
- name: Account Management
paths:
  /api/v3/connected_accounts/{nanoid}:
    get:
      summary: Get connected account details by ID
      description: Retrieves comprehensive details of a connected account, including authentication configuration, connection status, and all parameters needed for API requests.
      tags:
      - Account Management
      operationId: getConnectedAccountsByNanoid
      security:
      - CookieAuth: []
      - ApiKeyAuth: []
      - UserApiKeyAuth: []
      parameters:
      - schema:
          type: string
          format: connectedAccountId
        required: true
        description: The unique identifier (nanoid) of the connected account
        example: ca_1a2b3c4d5e6f
        name: nanoid
        in: path
      responses:
        '200':
          description: Successfully retrieved connected account details with all authentication parameters and connection status
          content:
            application/json:
              schema:
                type: object
                properties:
                  toolkit:
                    type: object
                    properties:
                      slug:
                        type: string
                        description: The slug of the toolkit
                    required:
                    - slug
                  auth_config:
                    type: object
                    properties:
                      id:
                        type: string
                        format: authConfigId
                        description: The id of the auth config
                      auth_scheme:
                        type: string
                        enum:
                        - OAUTH2
                        - OAUTH1
                        - API_KEY
                        - BASIC
                        - BILLCOM_AUTH
                        - BEARER_TOKEN
                        - GOOGLE_SERVICE_ACCOUNT
                        - NO_AUTH
                        - BASIC_WITH_JWT
                        - CALCOM_AUTH
                        - SERVICE_ACCOUNT
                        - SAML
                        - DCR_OAUTH
                        - S2S_OAUTH2
                        description: the authScheme is part of the connection state use it there
                        deprecated: true
                      is_composio_managed:
                        type: boolean
                        description: Whether the auth config is managed by Composio
                      is_disabled:
                        type: boolean
                        description: Whether the auth config is disabled
                      deprecated:
                        type: object
                        properties:
                          uuid:
                            type: string
                            format: uuid
                            description: The uuid of the auth config
                        required:
                        - uuid
                        deprecated: true
                    required:
                    - id
                    - auth_scheme
                    - is_composio_managed
                    - is_disabled
                  id:
                    type: string
                    format: connectedAccountId
                    description: The id of the connection
                  word_id:
                    type: string
                    nullable: true
                    description: A short, token-friendly identifier for multi-account disambiguation, typically toolkit-prefixed with 1-2 words (e.g., "gmail_red-castle")
                  alias:
                    type: string
                    nullable: true
                    description: A user-defined alias for the connected account
                  user_id:
                    type: string
                    description: This is deprecated, we will not be providing userId from this api anymore, you will only be able to read via userId not get it back
                    deprecated: true
                  status:
                    type: string
                    enum:
                    - INITIALIZING
                    - INITIATED
                    - ACTIVE
                    - FAILED
                    - EXPIRED
                    - INACTIVE
                    - REVOKED
                    description: The status of the connection
                  experimental:
                    type: object
                    properties:
                      account_type:
                        type: string
                        enum:
                        - PRIVATE
                        - SHARED
                        description: Sharing model for this connected account. PRIVATE is usable only by the owning user_id. SHARED is reachable from a tool-router session only when explicitly pinned in the session config.
                        x-experimental: true
                      acl_config_for_shared:
                        type: object
                        properties:
                          allow_all_users:
                            type: boolean
                          allowed_user_ids:
                            type: array
                            items:
                              type: string
                          not_allowed_user_ids:
                            type: array
                            items:
                              type: string
                        required:
                        - allow_all_users
                        - allowed_user_ids
                        - not_allowed_user_ids
                        description: Access control for SHARED connections. Visible only to the connection creator and project/org API key callers; non-creator cookie callers receive the response without this block.
                        x-experimental: true
                    required:
                    - account_type
                    description: Experimental features - not stable, may be modified or removed in future versions.
                    x-experimental: true
                  created_at:
                    type: string
                    description: The created at of the connection
                  updated_at:
                    type: string
                    description: The updated at of the connection
                  state:
                    oneOf:
                    - type: object
                      properties:
                        authScheme:
                          type: string
                          enum:
                          - OAUTH1
                        val:
                          oneOf:
                          - type: object
                            properties:
                              subdomain:
                                type: string
                              your-domain:
                                type: string
                              region:
                                type: string
                              shop:
                                type: string
                              account_url:
                                type: string
                              COMPANYDOMAIN:
                                type: string
                              extension:
                                type: string
                              form_api_base_url:
                                type: string
                              instanceEndpoint:
                                type: string
                              api_url:
                                type: string
                              borneo_dashboard_url:
                                type: string
                              proxy_username:
                                type: string
                              proxy_password:
                                type: string
                              domain:
                                type: string
                              version:
                                type: string
                              dc:
                                type: string
                              site_name:
                                type: string
                              instanceName:
                                type: string
                              account_id:
                                type: string
                              your_server:
                                type: string
                              server_location:
                                type: string
                              base_url:
                                type: string
                              status:
                                type: string
                                enum:
                                - INITIALIZING
                            required:
                            - status
                            additionalProperties:
                              nullable: true
                          - type: object
                            properties:
                              subdomain:
                                type: string
                              your-domain:
                                type: string
                              region:
                                type: string
                              shop:
                                type: string
                              account_url:
                                type: string
                              COMPANYDOMAIN:
                                type: string
                              extension:
                                type: string
                              form_api_base_url:
                                type: string
                              instanceEndpoint:
                                type: string
                              api_url:
                                type: string
                              borneo_dashboard_url:
                                type: string
                              proxy_username:
                                type: string
                              proxy_password:
                                type: string
                              domain:
                                type: string
                              version:
                                type: string
                              dc:
                                type: string
                              site_name:
                                type: string
                              instanceName:
                                type: string
                              account_id:
                                type: string
                              your_server:
                                type: string
                              server_location:
                                type: string
                              base_url:
                                type: string
                              status:
                                type: string
                                enum:
                                - INITIATED
                              oauth_token:
                                type: string
                              authUri:
                                type: string
                              oauth_token_secret:
                                type: string
                              redirectUrl:
                                type: string
                              callbackUrl:
                                type: string
                            required:
                            - status
                            - oauth_token
                            - authUri
                            - oauth_token_secret
                            - redirectUrl
                            additionalProperties:
                              nullable: true
                          - type: object
                            properties:
                              subdomain:
                                type: string
                              your-domain:
                                type: string
                              region:
                                type: string
                              shop:
                                type: string
                              account_url:
                                type: string
                              COMPANYDOMAIN:
                                type: string
                              extension:
                                type: string
                              form_api_base_url:
                                type: string
                              instanceEndpoint:
                                type: string
                              api_url:
                                type: string
                              borneo_dashboard_url:
                                type: string
                              proxy_username:
                                type: string
                              proxy_password:
                                type: string
                              domain:
                                type: string
                              version:
                                type: string
                              dc:
                                type: string
                              site_name:
                                type: string
                              instanceName:
                                type: string
                              account_id:
                                type: string
                              your_server:
                                type: string
                              server_location:
                                type: string
                              base_url:
                                type: string
                              status:
                                type: string
                                enum:
                                - ACTIVE
                              oauth_token:
                                type: string
                              oauth_token_secret:
                                type: string
                              oauth_verifier:
                                type: string
                              consumer_key:
                                type: string
                              redirectUrl:
                                type: string
                              callback_url:
                                type: string
                            required:
                            - status
                            - oauth_token
                            - oauth_token_secret
                            additionalProperties:
                              nullable: true
                          - type: object
                            properties:
                              subdomain:
                                type: string
                              your-domain:
                                type: string
                              region:
                                type: string
                              shop:
                                type: string
                              account_url:
                                type: string
                              COMPANYDOMAIN:
                                type: string
                              extension:
                                type: string
                              form_api_base_url:
                                type: string
                              instanceEndpoint:
                                type: string
                              api_url:
                                type: string
                              borneo_dashboard_url:
                                type: string
                              proxy_username:
                                type: string
                              proxy_password:
                                type: string
                              domain:
                                type: string
                              version:
                                type: string
                              dc:
                                type: string
                              site_name:
                                type: string
                              instanceName:
                                type: string
                              account_id:
                                type: string
                              your_server:
                                type: string
                              server_location:
                                type: string
                              base_url:
                                type: string
                              status:
                                type: string
                                enum:
                                - FAILED
                              error:
                                type: string
                              error_description:
                                type: string
                            required:
                            - status
                            additionalProperties:
                              nullable: true
                          - type: object
                            properties:
                              subdomain:
                                type: string
                              your-domain:
                                type: string
                              region:
                                type: string
                              shop:
                                type: string
                              account_url:
                                type: string
                              COMPANYDOMAIN:
                                type: string
                              extension:
                                type: string
                              form_api_base_url:
                                type: string
                              instanceEndpoint:
                                type: string
                              api_url:
                                type: string
                              borneo_dashboard_url:
                                type: string
                              proxy_username:
                                type: string
                              proxy_password:
                                type: string
                              domain:
                                type: string
                              version:
                                type: string
                              dc:
                                type: string
                              site_name:
                                type: string
                              instanceName:
                                type: string
                              account_id:
                                type: string
                              your_server:
                                type: string
                              server_location:
                                type: string
                              base_url:
                                type: string
                              status:
                                type: string
                                enum:
                                - EXPIRED
                              expired_at:
                                type: string
                            required:
                            - status
                            additionalProperties:
                              nullable: true
                          - type: object
                            properties:
                              subdomain:
                                type: string
                              your-domain:
                                type: string
                              region:
                                type: string
                              shop:
                                type: string
                              account_url:
                                type: string
                              COMPANYDOMAIN:
                                type: string
                              extension:
                                type: string
                              form_api_base_url:
                                type: string
                              instanceEndpoint:
                                type: string
                              api_url:
                                type: string
                              borneo_dashboard_url:
                                type: string
                              proxy_username:
                                type: string
                              proxy_password:
                                type: string
                              domain:
                                type: string
                              version:
                                type: string
                              dc:
                                type: string
                              site_name:
                                type: string
                              instanceName:
                                type: string
                              account_id:
                                type: string
                              your_server:
                                type: string
                              server_location:
                                type: string
                              base_url:
                                type: string
                              status:
                                type: string
                                enum:
                                - INACTIVE
                              oauth_token:
                                type: string
                              oauth_token_secret:
                                type: string
                              oauth_verifier:
                                type: string
                              consumer_key:
                                type: string
                              redirectUrl:
                                type: string
                              callback_url:
                                type: string
                            required:
                            - status
                            - oauth_token
                            - oauth_token_secret
                            additionalProperties:
                              nullable: true
                      required:
                      - authScheme
                      - val
                    - type: object
                      properties:
                        authScheme:
                          type: string
                          enum:
                          - OAUTH2
                        val:
                          oneOf:
                          - type: object
                            properties:
                              subdomain:
                                type: string
                              your-domain:
                                type: string
                              region:
                                type: string
                              shop:
                                type: string
                              account_url:
                                type: string
                              COMPANYDOMAIN:
                                type: string
                              extension:
                                type: string
                              form_api_base_url:
                                type: string
                              instanceEndpoint:
                                type: string
                              api_url:
                                type: string
                              borneo_dashboard_url:
                                type: string
                              proxy_username:
                                type: string
                              proxy_password:
                                type: string
                              domain:
                                type: string
                              version:
                                type: string
                              dc:
                                type: string
                              site_name:
                                type: string
                              instanceName:
                                type: string
                              account_id:
                                type: string
                              your_server:
                                type: string
                              server_location:
                                type: string
                              base_url:
                                type: string
                              status:
                                type: string
                                enum:
                                - INITIALIZING
                              state_prefix:
                                type: string
                                maxLength: 40
                                description: The oauth2 state prefix for the connection
                              long_redirect_url:
                                type: boolean
                                description: Whether to return the redirect url without shortening
                            required:
                            - status
                            additionalProperties:
                              nullable: true
                          - type: object
                            properties:
                              subdomain:
                                type: string
                              your-domain:
                                type: string
                              region:
                                type: string
                              shop:
                                type: string
                              account_url:
                                type: string
                              COMPANYDOMAIN:
                                type: string
                              extension:
                                type: string
                              form_api_base_url:
                                type: string
                              instanceEndpoint:
                                type: string
                              api_url:
                                type: string
                              borneo_dashboard_url:
                                type: string
                              proxy_username:
                                type: string
                              proxy_password:
                                type: string
                              domain:
                                type: string
                              version:
                                type: string
                              dc:
                                type: string
                              site_name:
                                type: string
                              instanceName:
                                type: string
                              account_id:
                                type: string
                              your_server:
                                type: string
                              server_location:
                                type: string
                              base_url:
                                type: string
                              status:
                                type: string
                                enum:
                                - INITIATED
                              state_prefix:
                                type: string
                                maxLength: 40
                                description: The oauth2 state prefix for the connection
                              long_redirect_url:
                                type: boolean
                                description: Whether to return the redirect url without shortening
                              code_verifier:
                                type: string
                              redirectUrl:
                                type: string
                              callback_url:
                                type: string
                              finalRedirectUri:
                                type: string
                              webhook_signature:
                                type: string
                            required:
                            - status
                            - redirectUrl
                            additionalProperties:
                              nullable: true
                          - type: object
                            properties:
                              subdomain:
                                type: string
                              your-domain:
                                type: string
                              region:
                                type: string
                              shop:
                                type: string
                              account_url:
                                type: string
                              COMPANYDOMAIN:
                                type: string
                              extension:
                                type: string
                              form_api_base_url:
                                type: string
                              instanceEndpoint:
                                type: string
                              api_url:
                                type: string
                              borneo_dashboard_url:
                                type: string
                              proxy_username:
                                type: string
                              proxy_password:
                                type: string
                              domain:
                                type: string
                              version:
                                type: string
                              dc:
                                type: string
                              site_name:
                                type: string
                              instanceName:
                                type: string
                              account_id:
                                type: string
                              your_server:
                                type: string
                              server_location:
                                type: string
                              base_url:
                                type: string
                              status:
                                type: string
                                enum:
                                - ACTIVE
                              state_prefix:
                                type: string
                                maxLength: 40
                                description: The oauth2 state prefix for the connection
                              long_redirect_url:
                                type: boolean
                                description: Whether to return the redirect url without shortening
                              access_token:
                                type: string
                              id_token:
                                type: string
                              token_type:
                                type: string
                              refresh_token:
                                type: string
                                nullable: true
                              expires_in:
                                anyOf:
                                - type: num

# --- truncated at 32 KB (226 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/composio/refs/heads/main/openapi/composio-account-management-api-openapi.yml