List Tools

GET /api/tools

List Tools

cURL

curl --request GET \
  --url https://api.example.com/api/tools \
  --header 'X-API-Key: <x-api-key>' \
  --header 'X-Organization-Id: <x-organization-id>'

Response

{
  "success": true,
  "data": [
    {
      "tool_id": "tool_a1b2c3d4e5f6",
      "tool_name": "GetOrderStatus",
      "tool_description": "Retrieves the status of a customer order",
      "http_method": "POST",
      "timeout_seconds": 30,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-20T14:45:00Z"
    },
    {
      "tool_id": "tool_b2c3d4e5f6a7",
      "tool_name": "CheckInventory",
      "tool_description": "Checks stock level for an item",
      "http_method": "GET",
      "timeout_seconds": 30,
      "created_at": "2024-01-10T09:00:00Z",
      "updated_at": "2024-01-10T09:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "eyJ0b29sX2lkIjogInRvb2xfeHl6In0=",
    "has_more": false,
    "page_size": 50,
    "total_count": 2
  }
}

List all custom tools configured for your organization with pagination.

Headers

X-API-Key · string · required

Your API key for authentication.

X-Organization-Id · string · required

The organization ID.

Query Parameters

limit · integer · default: "50"

Number of results per page (1-100).

cursor · string

Pagination cursor from previous response for fetching the next page.

Permissions

• tools:read (all roles)

Response

success · boolean

Indicates if the request was successful.

data · array

List of tool summary objects.

pagination · object

Pagination metadata.

Show properties

next_cursor · string

Cursor for the next page (null if no more pages).

has_more · boolean

Whether more results exist after this page.

page_size · integer

Number of items in this page.

total_count · integer

Total number of items (if available).

Response

{
  "success": true,
  "data": [
    {
      "tool_id": "tool_a1b2c3d4e5f6",
      "tool_name": "GetOrderStatus",
      "tool_description": "Retrieves the status of a customer order",
      "http_method": "POST",
      "timeout_seconds": 30,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-20T14:45:00Z"
    },
    {
      "tool_id": "tool_b2c3d4e5f6a7",
      "tool_name": "CheckInventory",
      "tool_description": "Checks stock level for an item",
      "http_method": "GET",
      "timeout_seconds": 30,
      "created_at": "2024-01-10T09:00:00Z",
      "updated_at": "2024-01-10T09:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "eyJ0b29sX2lkIjogInRvb2xfeHl6In0=",
    "has_more": false,
    "page_size": 50,
    "total_count": 2
  }
}