API ReferenceTools

List available tools

Markdown
GET/api/v3/tools

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.

Authorization

ApiKeyAuth
x-api-key<token>

API key authentication

In: header

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)

auth_config_idsstring | string[]

Comma-separated list of auth config IDs to filter tools by

importantenum

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

Possible values:
truefalse
tagsarray of string

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

scopesnullable array

Array of scopes to filter tools by)

searchstring

Free-text search query to find tools by name, description, or functionality

include_deprecatedboolean

Include deprecated tools in the response

Default: true
toolkit_versionsnull | string | object

Toolkit version specification. Use "latest" for latest versions or bracket notation for specific versions per toolkit.

limitnullable number

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 Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://backend.composio.dev/api/v3/tools?toolkit_versions=latest"
{
  "items": [
    {
      "slug": "github-actions",
      "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,
          "examples": [
            "octocat/Hello-World"
          ]
        },
        "workflow_id": {
          "type": "string",
          "description": "ID or filename of the workflow to trigger",
          "required": true,
          "examples": [
            "main.yml"
          ]
        }
      },
      "no_auth": false,
      "available_versions": [
        "20250905_00",
        "20250906_00"
      ],
      "version": "20250905_00",
      "output_parameters": {
        "run_id": {
          "type": "number",
          "description": "ID of the workflow run that was triggered",
          "examples": [
            12345678
          ]
        },
        "status": {
          "type": "string",
          "description": "Status of the workflow run",
          "enum": [
            "queued",
            "in_progress",
            "completed",
            "failed"
          ],
          "examples": [
            "completed"
          ]
        }
      },
      "scopes": [
        "https://www.googleapis.com/auth/gmail.modify"
      ],
      "tags": [
        "ci-cd",
        "github",
        "automation",
        "devops"
      ],
      "is_deprecated": false,
      "deprecated": {
        "displayName": "GitHub Actions",
        "version": "20250905_00",
        "available_versions": [
          "20250905_00",
          "20250906_00"
        ],
        "is_deprecated": false,
        "toolkit": {
          "logo": "https://github.githubassets.com/assets/GitHub-Mark-ea2971cee799.png"
        }
      }
    }
  ],
  "next_cursor": "string",
  "total_pages": 0,
  "current_page": 0,
  "total_items": 0
}
{
  "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"
    ]
  }
}
{
  "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"
    ]
  }
}