Get all Tools in an Organization

This endpoint allows clients to retrieve a list of all tools available in an organization.
It provides details about each tool, including its name, description, and status.

Path Parameters:

organization_id (int): The ID of the organization.

Query Parameters:

include_draft (str): Whether to include draft tools. Default is 'False'.

default (str): Whether to include default tools. Default is 'False'.

enabled (str): Whether to include enabled tools. Default is 'False'.

paginated (str): Whether to paginate the response. Default is 'False'.

page (int): In case of paginated response, the page number to return. Default is 1.

items_per_page (int): In case of paginated response, the number of items per page. Default is 20.

query (str): The query to search for tools.

sort_by (str): The field to sort the tools by. Default is 'modified_on'. Options are 'modified_on', 'created_on', 'name', 'description', 'tool_type', 'is_enabled', 'is_default', 'owner'. Use '-' prefix for descending order.

category (str): Filter by category name.

tool_classification (str): Filter by tool classification ('Internal' or 'External').

tool_type (str): Filter by tool type (rag, api, web_search, attachment, retriever, mcp).

Returns:

A response containing a list of all tools in the organization.

Current Version:

2.1.5

Changelog:

2.0.1: Added tool ordering by modified_on field

2.1.0: Added query parameter to search for tools and pagination

2.1.1: Added sort_by parameter to sort the tools

2.1.2: Added category parameter to filter tools by category

2.1.3: Added tool_classification parameter to filter by internal/external tools

2.1.4: Documentation tweaks and alignment with Agent tool endpoint

2.1.5: Modified include_draft, default, and enabled filters

curl --location --globoff 'https:///api/v2/organizations//tools?category=&default=&enabled=&include_draft=&items_per_page=&page=&paginated=&query=&sort_by=&tool_classification=&tool_type=' \ --header 'Ocp-Apim-Subscription-Key: ' \ --header 'Authorization: Bearer '

{ "success": true, "message": "string", "data": { "items": [ { "id": 0, "name": "string", "description": "string", "org": 0, "tool_type": "rag", "created_by": "string", "is_enabled": true, "is_default": true, "is_internal": true, "connection": true, "tool_classification": "string", "category": "string", "search_engine": "string", "search_engine_url": "string", "search_engine_key": "string", "top_k": 0, "include_domains": [ "string" ], "headers": {}, "system_prompt": "", "base_template": 0, "n_attachments": 0, "server_url": "string", "transport": "string", "enabled_actions": [ { "property1": "string", "property2": "string" } ] } ], "meta": { "property1": "string", "property2": "string" } } }

Get all Tools in an Organization

Request

Responses