Toolkits

Get toolkit by slug

Changed on

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.

get/api/v3.1/toolkits/{slug}

Request

  • Base URL
    https://backend.composio.dev
  • URL
    https://backend.composio.dev/api/v3.1/toolkits/{slug}
  • Auth
    • API key in header x-api-key
    • or API key in header x-user-api-key

Path parameters

slugstring required

The unique slug identifier of the toolkit to retrieve

Example:github

Toolkit slug identifier

Query parameters

versionstring

Version of the toolkit

Example:20250905_00

Response

Successfully retrieved detailed information about the requested toolkit, including authentication options, metadata, and feature counts.

slugstring required

URL-friendly unique identifier for the toolkit

namestring required

Human-readable name of the toolkit

type'native' | 'custom' required

Toolkit provenance: "native" for Composio-managed toolkits, "custom" for a project-registered custom (MCP) toolkit

enabledboolean required

Indicates if this toolkit is currently enabled and available for use

access'all' | 'user'

[EXPERIMENTAL] Custom toolkits only. "all": every user in the project can use it. "user": only the user it was created for can.

composio_managed_auth_schemesstring[]

List of authentication methods that Composio manages for this toolkit

is_local_toolkitboolean required

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.

auth_guide_urlstring nullable

URL to a guide page with authentication setup instructions for this toolkit

base_urlstring

If evaluation of base URL needs some connection info (like shopify), please create the connection and get the base URL from there

get_current_user_endpointstring

Endpoint to get the current user

get_current_user_endpoint_methodstring

HTTP method to use when calling the get current user endpoint (e.g., GET, POST)

Example response

{
  "slug": "github",
  "name": "GitHub",
  "type": "native",
  "enabled": true,
  "access": "all",
  "composio_managed_auth_schemes": [
    "oauth2"
  ],
  "composio_managed_auth": [
    {
      "mode": "OAUTH2",
      "scopes": {
        "available": [
          "read",
          "write"
        ]
      },
      "user_scopes": {
        "available": [
          "search:read",
          "users:read"
        ]
      }
    }
  ],
  "auth_config_details": [
    {
      "mode": "oauth2",
      "required_scopes": [
        "offline_access",
        "User.Read"
      ],
      "proxy": {
        "base_url": "https://auth.example.com/proxy"
      },
      "name": "OAuth 2.0",
      "auth_hint_url": "https://github.com/settings/tokens"
    }
  ],
  "auth_guide_url": "https://composio.dev/auth/github",
  "base_url": "https://api.github.com",
  "meta": {
    "created_at": "2023-01-15T09:30:00.000Z",
    "updated_at": "2023-05-20T14:45:00.000Z",
    "description": "Integrate with GitHub repositories, issues, pull requests, and more.",
    "logo": "https://assets.composio.dev/logos/github.png",
    "app_url": "https://github.com",
    "categories": [
      {
        "name": "Developer Tools",
        "slug": "developer-tools"
      },
      {
        "name": "Productivity",
        "slug": "productivity"
      }
    ],
    "triggers_count": 5,
    "tools_count": 12,
    "version": "20250905_00",
    "available_versions": [
      "20250905_00",
      "20250906_00"
    ]
  },
  "get_current_user_endpoint_method": "GET"
}

Changes

  • 98956f31abf3Revision changes
    • info

      api operation id getV3_1ToolkitsBySlug removed and replaced with getToolkitsBySlug

    • info

      api tag Integration removed

    • info

      added the optional property to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

  • 7957524a2590Revision changes
    • info

      added the required property // to the response with the status