> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get toolkit by slug

> Retrieves comprehensive information about a specific toolkit using its unique slug identifier. This endpoint provides detailed metadata, authentication configuration options, and feature counts for the requested toolkit.



## OpenAPI

````yaml api-reference/openapi-v3.json GET /api/v3/toolkits/{slug}
openapi: 3.0.0
info:
  version: 3.0.0
  title: Composio Platform API
  description: >-
    Composio v3 API — legacy endpoints under /api/v3/. Use v3.1 for new
    integrations.
  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: Composio production API
security:
  - ApiKeyAuth: []
tags:
  - name: Authentication
    description: Authentication related endpoints
    x-group: Authentication
  - name: Auth Configs
    description: Authentication configuration management
    x-group: Auth Configs
  - name: Connected Accounts
    description: Connected account management
    x-group: Connected Accounts
  - name: Logs
    description: Logging and monitoring
    x-group: Logs
  - name: OpenAPI
    description: OpenAPI specification management
    x-group: OpenAPI
  - name: Organization
    description: Organization management
    x-group: Organization
  - name: API Keys
    description: API key management
    x-group: API Keys
  - name: Webhooks
    description: Webhook configuration
    x-group: Webhooks
  - name: Webhook Endpoints
    description: >-
      Per-OAuth-app webhook ingress endpoints. Inbound URLs the provider posts
      to, plus signing secret storage and verification.
    x-group: Webhook Endpoints
  - name: Webhook Subscriptions
    description: >-
      Webhook delivery subscriptions. Outbound URLs Composio posts trigger
      events to, plus signing secret rotation and event-type filters.
    x-group: Webhook Subscriptions
  - name: Team
    description: Team member management
    x-group: Team
  - name: Consumer Skills
    description: Organization-authored Skill management
    x-group: Consumer Skills
  - name: Toolkits
    description: Toolkit and tool management
    x-group: Toolkits
  - name: Tools
    description: Tool execution endpoints
    x-group: Tools
  - name: Triggers
    description: Trigger management and execution
    x-group: Triggers
  - name: Payments
    description: Payment and subscription management
    x-group: Payments
  - name: Billing
    description: Dashboard billing state — usage, subscription, contract (cookie-auth only)
    x-group: Billing
  - name: Compliance
    description: Organization compliance agreements and acceptance state
    x-group: Compliance
  - name: Files
    description: File management
    x-group: Files
  - name: MCP
    description: MCP server management
    x-group: MCP
  - name: MCP Partner
    description: MCP partner management
    x-group: MCP Partner
  - name: Stripe Projects
    description: Stripe Projects provisioning
    x-group: Stripe Projects
  - name: Tool Router
    description: (Labs) Tool router endpoints
    x-group: Sessions (Prev Tool Router)
  - name: Playground
    description: Dashboard playground chat
    x-group: Playground
  - name: Arena
    description: Arena conversations, messages and terms
    x-group: Arena
  - name: Organization Management
    description: Organization Management API endpoints.
    x-group: Organization Management
  - name: Projects
    description: Projects API endpoints.
    x-group: Projects
paths:
  /api/v3/toolkits/{slug}:
    get:
      tags:
        - Toolkits
      summary: Get toolkit by slug
      description: >-
        Retrieves comprehensive information about a specific toolkit using its
        unique slug identifier. This endpoint provides detailed metadata,
        authentication configuration options, and feature counts for the
        requested toolkit.
      operationId: getToolkitsBySlug
      parameters:
        - schema:
            type: string
            description: The unique slug identifier of the toolkit to retrieve
            example: github
          required: true
          description: Toolkit slug identifier
          name: slug
          in: path
        - schema:
            type: string
            default: latest
            description: Version of the toolkit
            example: 20250905_00
          required: false
          description: Version of the toolkit
          name: version
          in: query
      responses:
        '200':
          description: >-
            Successfully retrieved detailed information about the requested
            toolkit, including authentication options, metadata, and feature
            counts.
          content:
            application/json:
              schema:
                type: object
                properties:
                  slug:
                    type: string
                    description: URL-friendly unique identifier for the toolkit
                    example: github
                  name:
                    type: string
                    description: Human-readable name of the toolkit
                    example: GitHub
                  type:
                    type: string
                    enum:
                      - native
                      - custom
                    description: >-
                      Toolkit provenance: "native" for Composio-managed
                      toolkits, "custom" for a project-registered custom (MCP)
                      toolkit
                    example: native
                  enabled:
                    type: boolean
                    description: >-
                      Indicates if this toolkit is currently enabled and
                      available for use
                    example: true
                  access:
                    type: string
                    enum:
                      - all
                      - user
                    description: >-
                      [EXPERIMENTAL] Custom toolkits only. "all": every user in
                      the project can use it. "user": only the user it was
                      created for can.
                    example: all
                    x-experimental: true
                  composio_managed_auth_schemes:
                    type: array
                    items:
                      type: string
                    description: >-
                      List of authentication methods that Composio manages for
                      this toolkit
                    example:
                      - oauth2
                  composio_managed_auth:
                    type: array
                    items:
                      type: object
                      properties:
                        mode:
                          type: string
                          description: >-
                            Authentication mode for the Composio-managed auth
                            config
                          example: OAUTH2
                        scopes:
                          type: object
                          properties:
                            available:
                              type: array
                              items:
                                type: string
                              description: Available OAuth scopes
                          required:
                            - available
                          description: >-
                            OAuth scopes available in the Composio-managed auth
                            config for this auth mode.
                          example:
                            available:
                              - read
                              - write
                        user_scopes:
                          type: object
                          properties:
                            available:
                              type: array
                              items:
                                type: string
                              description: Available OAuth user scopes
                          required:
                            - available
                          description: >-
                            OAuth user scopes available in the Composio-managed
                            auth config for this auth mode. Only present for
                            Slack toolkits.
                          example:
                            available:
                              - search:read
                              - users:read
                      required:
                        - mode
                        - scopes
                    description: >-
                      Managed-auth-only metadata, including the supported OAuth
                      scope ceiling.
                  is_local_toolkit:
                    type: boolean
                    description: >-
                      DEPRECATED: This field is no longer meaningful and will
                      always return false. It was previously used to indicate if
                      a toolkit is specific to the current project.
                    deprecated: true
                    example: false
                  auth_config_details:
                    type: array
                    items:
                      type: object
                      properties:
                        mode:
                          type: string
                          description: >-
                            The type of authentication mode (e.g., oauth2,
                            basic_auth, api_key)
                          example: oauth2
                        required_scopes:
                          type: array
                          items:
                            type: string
                          description: >-
                            OAuth scopes that are always requested for this
                            authentication method regardless of the
                            tool-specific scopes selected, such as token-refresh
                            (e.g. offline_access) and identity/whoami scopes.
                            Consumers handling authentication themselves should
                            union these with per-tool scopes.
                          example:
                            - offline_access
                            - User.Read
                        fields:
                          type: object
                          properties:
                            auth_config_creation:
                              type: object
                              properties:
                                required:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      name:
                                        type: string
                                      displayName:
                                        type: string
                                      default:
                                        type: string
                                        nullable: true
                                      type:
                                        type: string
                                      description:
                                        type: string
                                      required:
                                        type: boolean
                                      is_secret:
                                        type: boolean
                                        description: >-
                                          Whether this field holds a
                                          secret/credential value. Clients use it
                                          to decide whether to mask the input.
                                      legacy_template_name:
                                        type: string
                                      user_visible:
                                        type: boolean
                                        description: >-
                                          Whether this field is shown to the end
                                          user in the hosted connect flow. Fields
                                          with `false` are never required — the
                                          field's `default` applies unless the
                                          developer supplies a value on the auth
                                          config (e.g. as a shared credential).
                                    required:
                                      - name
                                      - displayName
                                      - type
                                      - description
                                      - required
                                      - user_visible
                                optional:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      name:
                                        type: string
                                      displayName:
                                        type: string
                                      default:
                                        type: string
                                        nullable: true
                                      type:
                                        type: string
                                      description:
                                        type: string
                                      required:
                                        type: boolean
                                      is_secret:
                                        type: boolean
                                        description: >-
                                          Whether this field holds a
                                          secret/credential value. Clients use it
                                          to decide whether to mask the input.
                                      legacy_template_name:
                                        type: string
                                      user_visible:
                                        type: boolean
                                        description: >-
                                          Whether this field is shown to the end
                                          user in the hosted connect flow. Fields
                                          with `false` are never required — the
                                          field's `default` applies unless the
                                          developer supplies a value on the auth
                                          config (e.g. as a shared credential).
                                    required:
                                      - name
                                      - displayName
                                      - type
                                      - description
                                      - required
                                      - user_visible
                              required:
                                - required
                                - optional
                              description: >-
                                Form fields needed when creating an
                                authentication configuration
                            connected_account_initiation:
                              type: object
                              properties:
                                required:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      name:
                                        type: string
                                      displayName:
                                        type: string
                                      default:
                                        type: string
                                        nullable: true
                                      type:
                                        type: string
                                      description:
                                        type: string
                                      required:
                                        type: boolean
                                      is_secret:
                                        type: boolean
                                        description: >-
                                          Whether this field holds a
                                          secret/credential value. Clients use it
                                          to decide whether to mask the input.
                                      legacy_template_name:
                                        type: string
                                      user_visible:
                                        type: boolean
                                        description: >-
                                          Whether this field is shown to the end
                                          user in the hosted connect flow. Fields
                                          with `false` are never required — the
                                          field's `default` applies unless the
                                          developer supplies a value on the auth
                                          config (e.g. as a shared credential).
                                    required:
                                      - name
                                      - displayName
                                      - type
                                      - description
                                      - required
                                      - user_visible
                                optional:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      name:
                                        type: string
                                      displayName:
                                        type: string
                                      default:
                                        type: string
                                        nullable: true
                                      type:
                                        type: string
                                      description:
                                        type: string
                                      required:
                                        type: boolean
                                      is_secret:
                                        type: boolean
                                        description: >-
                                          Whether this field holds a
                                          secret/credential value. Clients use it
                                          to decide whether to mask the input.
                                      legacy_template_name:
                                        type: string
                                      user_visible:
                                        type: boolean
                                        description: >-
                                          Whether this field is shown to the end
                                          user in the hosted connect flow. Fields
                                          with `false` are never required — the
                                          field's `default` applies unless the
                                          developer supplies a value on the auth
                                          config (e.g. as a shared credential).
                                    required:
                                      - name
                                      - displayName
                                      - type
                                      - description
                                      - required
                                      - user_visible
                              required:
                                - required
                                - optional
                              description: >-
                                Form fields needed when connecting a user
                                account with this authentication method
                          required:
                            - auth_config_creation
                            - connected_account_initiation
                          description: >-
                            Field groups required for different authentication
                            stages
                        proxy:
                          type: object
                          properties:
                            base_url:
                              type: string
                              description: >-
                                URL to which authentication requests will be
                                proxied
                              example: https://auth.example.com/proxy
                          required:
                            - base_url
                          description: >-
                            Configuration for proxying authentication requests
                            to external services
                        name:
                          type: string
                          description: Display name for this authentication method
                          example: OAuth 2.0
                        auth_hint_url:
                          type: string
                          nullable: true
                          description: >-
                            URL to a page where users can obtain or configure
                            credentials for this authentication method
                          example: https://github.com/settings/tokens
                        deprecated_auth_provider_details:
                          type: object
                          properties:
                            authorization_url:
                              type: string
                            token_url:
                              type: string
                          description: >-
                            Authentication URL fields for OAuth 2.0 and OAuth
                            1.0. We don't recommend using this field for
                            authentication and might break post Aug 31 2025.
                          deprecated: true
                      required:
                        - mode
                        - required_scopes
                        - fields
                        - name
                      description: Detailed configuration for an authentication method
                    description: >-
                      Complete authentication configuration details for each
                      supported auth method
                  auth_guide_url:
                    type: string
                    nullable: true
                    description: >-
                      URL to a guide page with authentication setup instructions
                      for this toolkit
                    example: https://composio.dev/auth/github
                  base_url:
                    type: string
                    description: >-
                      If evaluation of base URL needs some connection info (like
                      shopify), please create the connection and get the base
                      URL from there
                    example: https://api.github.com
                  meta:
                    type: object
                    properties:
                      created_at:
                        type: string
                        description: Creation date and time of the toolkit
                        example: '2023-01-15T09:30:00.000Z'
                      updated_at:
                        type: string
                        description: Last modification date and time of the toolkit
                        example: '2023-05-20T14:45:00.000Z'
                      description:
                        type: string
                        description: >-
                          Human-readable description explaining the toolkit's
                          purpose and functionality
                        example: >-
                          Integrate with GitHub repositories, issues, pull
                          requests, and more.
                      logo:
                        type: string
                        description: Image URL for the toolkit's branding
                        example: https://assets.composio.dev/logos/github.png
                      app_url:
                        type: string
                        nullable: true
                        description: >-
                          Link to the toolkit's main application or service
                          website
                        example: https://github.com
                      categories:
                        type: array
                        items:
                          type: object
                          properties:
                            name:
                              type: string
                              description: Human-readable category name
                              example: Developer Tools
                            slug:
                              type: string
                              description: URL-friendly identifier for the category
                              example: developer-tools
                          required:
                            - name
                            - slug
                        description: List of categories associated with this toolkit
                        example:
                          - name: Developer Tools
                            slug: developer-tools
                          - name: Productivity
                            slug: productivity
                      triggers_count:
                        type: number
                        description: Count of available triggers in this toolkit
                        example: 5
                      tools_count:
                        type: number
                        description: Count of available tools in this toolkit
                        example: 12
                      version:
                        type: string
                        description: Version of the toolkit
                        example: 20250905_00
                      available_versions:
                        type: array
                        items:
                          type: string
                        description: Available versions of the toolkit
                        example:
                          - 20250905_00
                          - 20250906_00
                    required:
                      - created_at
                      - updated_at
                      - description
                      - logo
                      - categories
                      - triggers_count
                      - tools_count
                      - version
                      - available_versions
                    description: >-
                      Comprehensive metadata for the toolkit including dates,
                      descriptions, and statistics
                  get_current_user_endpoint:
                    type: string
                    description: Endpoint to get the current user
                  get_current_user_endpoint_method:
                    type: string
                    description: >-
                      HTTP method to use when calling the get current user
                      endpoint (e.g., GET, POST)
                    example: GET
                  deprecated:
                    type: object
                    properties:
                      toolkitId:
                        type: string
                      getCurrentUserEndpoint:
                        type: string
                      rawProxyInfoByAuthSchemes:
                        type: array
                        items:
                          type: object
                          additionalProperties: {}
                    required:
                      - toolkitId
                      - rawProxyInfoByAuthSchemes
                required:
                  - slug
                  - name
                  - type
                  - enabled
                  - composio_managed_auth
                  - is_local_toolkit
                  - meta
                  - deprecated
                description: Detailed information about a single toolkit
        '400':
          description: >-
            Bad request. The toolkit slug may be invalid or in an incorrect
            format.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: >-
            Unauthorized. Authentication is required or the provided credentials
            are invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: >-
            Not found. The requested toolkit does not exist or is not accessible
            to the authenticated project.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: >-
            Internal server error. An unexpect ed error occurred while
            processing the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKeyAuth: []
        - UserApiKeyAuth: []
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
            code:
              type: number
            slug:
              type: string
            status:
              type: number
            request_id:
              type: string
            suggested_fix:
              type: string
            errors:
              type: array
              items:
                type: string
          required:
            - message
            - code
            - slug
            - status
      required:
        - error
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Your Composio project API key. Create or copy it from the Composio
        dashboard.
      x-default: your-project-api-key
    UserApiKeyAuth:
      type: apiKey
      in: header
      name: x-user-api-key
      description: Your Composio user API key for user-scoped endpoints.
      x-default: your-user-api-key

````