Toolkits

List available toolkits

Changed on

Retrieves a comprehensive list of toolkits of their latest versions that are available to the authenticated project. Toolkits represent integration points with external services and applications, each containing a collection of tools and triggers. This endpoint supports filtering by category and management type, as well as different sorting options.

get/api/v3.1/toolkits

Request

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

Query parameters

categorystring

Category ID or name to filter toolkits by

Example:productivity

Filter toolkits by category

managed_by'composio' | 'all' | 'project'

Deprecated: Entity responsible for managing the toolkits

Deprecated: Filter toolkits by who manages them

type'native' | 'custom' | 'all'

Filter by toolkit provenance: "native" (Composio-managed), "custom" (project-registered custom toolkits), or "all". Takes precedence over managed_by when both are supplied.

Example:custom

Filter toolkits by provenance (alias over managed_by)

sort_by'usage' | 'alphabetically'

Determines how toolkits should be sorted in the response

Sort order for returned toolkits

include_deprecatedboolean nullable

Include deprecated toolkits in the response

Example:true
searchstring

Search query to filter toolkits by name, slug, or description (minimum 1 character)

Example:gmail

Search query to filter toolkits by name, slug, or description

user_idstring

[EXPERIMENTAL] List the custom toolkits this user can use. Without it, only custom toolkits with access "all" are listed.

Example:user_123
limitnumber nullable

Number of items per page, max allowed is 1000

cursorstring

Cursor for pagination. The cursor is a base64 encoded string of the page and limit. The page is the page number and the limit is the number of items per page. The cursor is used to paginate through the items. The cursor is not required for the first page.

Response

Toolkits retrieved successfully. Returns a paginated list of available toolkits with detailed metadata.

next_cursorstring nullable
total_pagesnumber required
current_pagenumber required
total_itemsnumber required

Example response

{
  "items": [
    {
      "slug": "github",
      "name": "GitHub",
      "type": "native",
      "access": "all",
      "auth_schemes": [
        "oauth2",
        "api_key"
      ],
      "composio_managed_auth_schemes": [
        "oauth2"
      ],
      "auth_guide_url": "https://composio.dev/auth/github",
      "deprecated": {
        "toolkitId": "550e8400-e29b-41d4-a716-446655440000"
      },
      "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": [
          {
            "id": "developer-tools",
            "name": "Developer Tools"
          },
          {
            "id": "productivity",
            "name": "Productivity"
          }
        ],
        "triggers_count": 5,
        "tools_count": 12,
        "version": "20250905_00"
      }
    }
  ]
}

Changes

  • 98956f31abf3Revision changes
    • info

      api operation id getV3_1Toolkits removed and replaced with getToolkits

    • info

      api tag Integration removed

    • info

      added the new optional query request parameter user_id

    • info

      query request parameter managed_by was deprecated

    • info

      added the non-success response with the status

    • info

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

    • info

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

  • ebe821998eabRevision changes
    • info

      added the new optional query request parameter type

    • info

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