Tools

List available tools

Changed on

Retrieve a paginated list of available tools with comprehensive filtering, sorting and search capabilities. Use query parameters to narrow down results by toolkit, tags, or search terms.

get/api/v3.1/tools

Request

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

Query parameters

toolkit_slugstring

The slug of the toolkit to filter by

tool_slugsstring

Comma-separated list of specific tool slugs to retrieve (overrides other filters)

string
OR
string[]

DEPRECATED: This parameter will be removed in a future version. Filter directly instead with tool_slugs and toolkit_slug, which accepts a comma-separated list of toolkits.

important'true' | 'false'

Filter to only show important/featured tools (set to "true" to enable)

tagsstring[]

Filter tools by one or more tags (can be specified multiple times)

scopesstring[] nullable

Filter tools by one or more scopes (can be specified multiple times)

Array of scopes to filter tools by)

querystring

Full-text search query to filter tools by name, slug, or description. Applied as a soft filter on top of other filters.

searchstring

Deprecated: use "query" instead. Free-text search query to find tools by name, description, or functionality.

include_deprecatedboolean

Include deprecated tools in the response

include_pricingboolean

Whether to include published pricing within instant, when available. Defaults to false.

string
OR
object

Object representation of parsed bracket notation

Toolkit version specification. Use "latest" for latest versions or bracket notation for specific versions per toolkit. Defaults to the latest published version ("latest") when omitted.

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

Successfully retrieved tools list with pagination information

next_cursorstring nullable
total_pagesnumber required
current_pagenumber required
total_itemsnumber required

Example response

{
  "items": [
    {
      "slug": "GITHUB_CREATE_A_WORKFLOW_DISPATCH_EVENT",
      "name": "GitHub Actions",
      "description": "Automate GitHub workflows including CI/CD, issue management, and release processes",
      "toolkit": {
        "slug": "github",
        "name": "GitHub",
        "logo": "https://github.githubassets.com/assets/GitHub-Mark-ea2971cee799.png"
      },
      "input_parameters": {
        "repo_name": {
          "type": "string",
          "description": "GitHub repository name in owner/repo format",
          "required": true,
          "example": "octocat/Hello-World"
        },
        "workflow_id": {
          "type": "string",
          "description": "ID or filename of the workflow to trigger",
          "required": true,
          "example": "main.yml"
        }
      },
      "available_versions": [
        "20250905_00",
        "20250906_00"
      ],
      "version": "20250905_00",
      "output_parameters": {
        "run_id": {
          "type": "number",
          "description": "ID of the workflow run that was triggered",
          "example": 12345678
        },
        "status": {
          "type": "string",
          "description": "Status of the workflow run",
          "example": "completed",
          "enum": [
            "queued",
            "in_progress",
            "completed",
            "failed"
          ]
        }
      },
      "scopes": [
        "https://www.googleapis.com/auth/gmail.modify"
      ],
      "scope_requirements": {
        "all_of": [
          "read:user",
          {
            "any_of": [
              "repo",
              "public_repo"
            ]
          }
        ]
      },
      "tags": [
        "ci-cd",
        "github",
        "automation",
        "devops"
      ],
      "human_description": "Create a new issue in a GitHub repository",
      "deprecated": {
        "displayName": "GitHub Actions",
        "version": "20250905_00",
        "available_versions": [
          "20250905_00",
          "20250906_00"
        ],
        "toolkit": {
          "logo": "https://github.githubassets.com/assets/GitHub-Mark-ea2971cee799.png"
        }
      }
    }
  ]
}

Changes

  • 98956f31abf3Revision changes
    • info

      api operation id getV3_1Tools removed and replaced with getTools

    • info

      added the new optional query request parameter include_pricing

    • info

      query request parameter auth_config_ids was deprecated

    • info

      query request parameter toolkit_versions list-of-types was widened by adding types null

    • info

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

  • c039e97e7f14Revision changes
    • info

      added the optional property ///////// to the 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