API ReferenceToolkits

Get toolkit by slug

Markdown
GET
/api/v3/toolkits/{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.

Authorization

ApiKeyAuth
x-api-key<token>

API key authentication

In: header

Path Parameters

slug*string

Toolkit slug identifier

Query Parameters

version?string

Version of the toolkit

Default"latest"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://backend.composio.dev/api/v3/toolkits/github"
{
  "slug": "github",
  "name": "GitHub",
  "enabled": true,
  "composio_managed_auth_schemes": [
    "oauth2"
  ],
  "is_local_toolkit": false,
  "auth_config_details": [
    {
      "mode": "oauth2",
      "fields": {
        "auth_config_creation": {
          "required": [
            {
              "name": "string",
              "displayName": "string",
              "default": "string",
              "type": "string",
              "description": "string",
              "required": true,
              "legacy_template_name": "string"
            }
          ],
          "optional": [
            {
              "name": "string",
              "displayName": "string",
              "default": "string",
              "type": "string",
              "description": "string",
              "required": true,
              "legacy_template_name": "string"
            }
          ]
        },
        "connected_account_initiation": {
          "required": [
            {
              "name": "string",
              "displayName": "string",
              "default": "string",
              "type": "string",
              "description": "string",
              "required": true,
              "legacy_template_name": "string"
            }
          ],
          "optional": [
            {
              "name": "string",
              "displayName": "string",
              "default": "string",
              "type": "string",
              "description": "string",
              "required": true,
              "legacy_template_name": "string"
            }
          ]
        }
      },
      "proxy": {
        "base_url": "https://auth.example.com/proxy"
      },
      "name": "OAuth 2.0",
      "deprecated_auth_provider_details": {
        "authorization_url": "string",
        "token_url": "string"
      }
    }
  ],
  "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": "string",
  "get_current_user_endpoint_method": "GET",
  "deprecated": {
    "toolkitId": "string",
    "getCurrentUserEndpoint": "string",
    "rawProxyInfoByAuthSchemes": [
      {
        "property1": null,
        "property2": null
      }
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}