# Get toolkit by slug

**Documentation:** /reference/api-reference/toolkits/getToolkitsBySlug

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/toolkits/{slug}`

**Endpoint:** `https://backend.composio.dev/api/v3/toolkits/{slug}`

**Summary:** Get toolkit by 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.

### Authentication

**ApiKeyAuth** - API Key in `header` header `x-api-key` OR **UserApiKeyAuth** - API Key in `header` header `x-user-api-key`

### Path Parameters

- `slug` (string) *(required)*: Toolkit slug identifier

### Query Parameters

- `version` (string): Version of the toolkit

### Responses

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

**Response Schema:**

- `slug` (string) *(required)*: URL-friendly unique identifier for the toolkit
- `name` (string) *(required)*: Human-readable name of the toolkit
- `enabled` (boolean) *(required)*: Indicates if this toolkit is currently enabled and available for use
- `composio_managed_auth_schemes` (array<string>): List of authentication methods that Composio manages for this toolkit
- `is_local_toolkit` (boolean) *(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_config_details` (array<object>): Complete authentication configuration details for each supported auth method
  - Array items:
    - `mode` (string) *(required)*: The type of authentication mode (e.g., oauth2, basic_auth, api_key)
    - `fields` (object) *(required)*: Field groups required for different authentication stages
      - `auth_config_creation` (object) *(required)*: Form fields needed when creating an authentication configuration
        - `required` (array<object>) *(required)*
          - Array items:
            - ...
        - `optional` (array<object>) *(required)*
          - Array items:
            - ...
      - `connected_account_initiation` (object) *(required)*: Form fields needed when connecting a user account with this authentication method
        - `required` (array<object>) *(required)*
          - Array items:
            - ...
        - `optional` (array<object>) *(required)*
          - Array items:
            - ...
    - `proxy` (object): Configuration for proxying authentication requests to external services
      - `base_url` (string) *(required)*: URL to which authentication requests will be proxied
    - `name` (string) *(required)*: Display name for this authentication method
    - `auth_hint_url` (string,null): URL to a page where users can obtain or configure credentials for this authentication method
    - `deprecated_auth_provider_details` (object): Authentication URL fields for OAuth 2.0 and OAuth 1.0. We don't recommend using this field for authentication and might break post Aug 31 2025.
      - `authorization_url` (string)
      - `token_url` (string)
- `auth_guide_url` (string,null): URL to a guide page with authentication setup instructions for this toolkit
- `base_url` (string): If evaluation of base URL needs some connection info (like shopify), please create the connection and get the base URL from there
- `meta` (object) *(required)*: Comprehensive metadata for the toolkit including dates, descriptions, and statistics
  - `created_at` (string) *(required)*: Creation date and time of the toolkit
  - `updated_at` (string) *(required)*: Last modification date and time of the toolkit
  - `description` (string) *(required)*: Human-readable description explaining the toolkit's purpose and functionality
  - `logo` (string) *(required)*: Image URL for the toolkit's branding
  - `app_url` (string,null): Link to the toolkit's main application or service website
  - `categories` (array<object>) *(required)*: List of categories associated with this toolkit
    - Array items:
      - `name` (string) *(required)*: Human-readable category name
      - `slug` (string) *(required)*: URL-friendly identifier for the category
  - `triggers_count` (number) *(required)*: Count of available triggers in this toolkit
  - `tools_count` (number) *(required)*: Count of available tools in this toolkit
  - `version` (string) *(required)*: Version of the toolkit
  - `available_versions` (array<string>) *(required)*: Available versions of the toolkit
- `get_current_user_endpoint` (string): Endpoint to get the current user
- `get_current_user_endpoint_method` (string): HTTP method to use when calling the get current user endpoint (e.g., GET, POST)
- `deprecated` (object) *(required)*
  - `toolkitId` (string) *(required)*
  - `getCurrentUserEndpoint` (string)
  - `rawProxyInfoByAuthSchemes` (array<object>) *(required)*
    - Array items:
      - `[key: string]` (any)

**Example Response:**

```json
{
  "slug": "string",
  "name": "string",
  "enabled": true,
  "composio_managed_auth_schemes": [
    "string"
  ],
  "is_local_toolkit": true,
  "auth_config_details": [
    {
      "mode": "string",
      "fields": {
        "auth_config_creation": "...",
        "connected_account_initiation": "..."
      },
      "proxy": {
        "base_url": "..."
      },
      "name": "string",
      "auth_hint_url": null,
      "deprecated_auth_provider_details": {
        "authorization_url": "...",
        "token_url": "..."
      }
    }
  ],
  "auth_guide_url": null,
  "base_url": "string",
  "meta": {
    "created_at": "string",
    "updated_at": "string",
    "description": "string",
    "logo": "string",
    "app_url": null,
    "categories": [
      {
        "name": "...",
        "slug": "..."
      }
    ],
    "triggers_count": 1,
    "tools_count": 1,
    "version": "string",
    "available_versions": [
      "string"
    ]
  },
  "get_current_user_endpoint": "string",
  "get_current_user_endpoint_method": "string",
  "deprecated": {
    "toolkitId": "string",
    "getCurrentUserEndpoint": "string",
    "rawProxyInfoByAuthSchemes": [
      {
        "key": "..."
      }
    ]
  }
}
```

#### 400 - Bad request. The toolkit slug may be invalid or in an incorrect format.

**Response Schema:**

- `error` (object) *(required)*
  - `message` (string) *(required)*
  - `code` (number) *(required)*
  - `slug` (string) *(required)*
  - `status` (number) *(required)*
  - `request_id` (string)
  - `suggested_fix` (string)
  - `errors` (array<string>)

#### 401 - Unauthorized. Authentication is required or the provided credentials are invalid.

**Response Schema:**

- `error` (object) *(required)*
  - `message` (string) *(required)*
  - `code` (number) *(required)*
  - `slug` (string) *(required)*
  - `status` (number) *(required)*
  - `request_id` (string)
  - `suggested_fix` (string)
  - `errors` (array<string>)

#### 404 - Not found. The requested toolkit does not exist or is not accessible to the authenticated project.

**Response Schema:**

- `error` (object) *(required)*
  - `message` (string) *(required)*
  - `code` (number) *(required)*
  - `slug` (string) *(required)*
  - `status` (number) *(required)*
  - `request_id` (string)
  - `suggested_fix` (string)
  - `errors` (array<string>)

#### 500 - Internal server error. An unexpect ed error occurred while processing the request.

**Response Schema:**

- `error` (object) *(required)*
  - `message` (string) *(required)*
  - `code` (number) *(required)*
  - `slug` (string) *(required)*
  - `status` (number) *(required)*
  - `request_id` (string)
  - `suggested_fix` (string)
  - `errors` (array<string>)

### Example cURL Request

```bash
curl -X GET "https://backend.composio.dev/api/v3/toolkits/string" \
  -H "x-api-key: YOUR_API_KEY"
```