Skip to main content
GET
/
api
/
tools
/
{tool_id}
Get Tool
curl --request GET \
  --url https://api.example.com/api/tools/{tool_id} \
  --header 'X-API-Key: <x-api-key>' \
  --header 'X-Organization-Id: <x-organization-id>'
{
  "success": true,
  "data": {
    "tool_id": "tool_a1b2c3d4e5f6",
    "tool_name": "GetOrderStatus",
    "tool_description": "Retrieves the status of a customer order using their order ID",
    "webhook_url": "https://api.shop.com/orders/status",
    "http_method": "POST",
    "headers": {
      "Authorization": "Bearer token123"
    },
    "parameters": [
      {
        "parameter_name": "order_id",
        "parameter_type": "string",
        "parameter_description": "The unique order identifier",
        "parameter_required": true
      }
    ],
    "timeout_seconds": 30,
    "client_id": "org_abc123",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-20T14:45:00Z"
  }
}
Get configuration details of a specific tool.

​
Headers

​
X-API-Key
string
required
Your API key for authentication.
​
X-Organization-Id
string
required
The organization ID.

​
Path Parameters

​
tool_id
string
required
The unique identifier of the tool (format: tool_[a-f0-9]{12,}).

​
Permissions

  • tools:read (all roles)

​
Response

​
success
boolean
Indicates if the request was successful.
​
data
object
The full tool configuration object.
{
  "success": true,
  "data": {
    "tool_id": "tool_a1b2c3d4e5f6",
    "tool_name": "GetOrderStatus",
    "tool_description": "Retrieves the status of a customer order using their order ID",
    "webhook_url": "https://api.shop.com/orders/status",
    "http_method": "POST",
    "headers": {
      "Authorization": "Bearer token123"
    },
    "parameters": [
      {
        "parameter_name": "order_id",
        "parameter_type": "string",
        "parameter_description": "The unique order identifier",
        "parameter_required": true
      }
    ],
    "timeout_seconds": 30,
    "client_id": "org_abc123",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-20T14:45:00Z"
  }
}

​
Errors

​
404
object
Tool not found.
​
403
object
Tool belongs to different organization.