close

List Custom Tools

List code-backed custom tools defined in a workspace, with opaque cursor pagination. Legacy personal tools are excluded.

GET/api/v2/custom-tools

Authorization

apiKey
X-API-Key<token>

Your Sim API key, personal or workspace-scoped. Generate one under Settings, then API Keys. Operations that reject workspace keys say so in their own description.

In: header

Query Parameters

workspaceId*string

Workspace that owns the custom tool.

Length1 <= length <= 128
search?string

Case-insensitive substring match against the tool title.

Length1 <= length <= 200
sortBy?string

Field used to sort the result.

Default"createdAt"
Value in"title" | "createdAt" | "updatedAt"
sortOrder?string

Sort direction.

Default"desc"
Value in"asc" | "desc"
limit?integer

Maximum custom tools to return per page. Must be a whole number from 1 to 100. Defaults to 50.

Default50
Range1 <= value <= 100
cursor?string

Opaque cursor from the previous page. Send it back with the same sort and filters; only limit may change. Change anything else and pagination must restart without a cursor.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://www.sim.ai/api/v2/custom-tools?workspaceId=string" \  -H "X-API-Key: YOUR_API_KEY"
{
  "data": [
    {
      "id": "V1StGXR8Z5jdHi6BmyT",
      "title": "lookup_order",
      "schema": {
        "type": "function",
        "function": {
          "name": "lookup_order",
          "description": "Look up an order by id",
          "parameters": {
            "type": "object",
            "properties": {
              "orderId": {
                "type": "string"
              }
            },
            "required": [
              "orderId"
            ]
          }
        }
      },
      "code": "return { ok: true }",
      "createdAt": "2026-06-01T09:14:00.000Z",
      "updatedAt": "2026-06-20T14:02:11.000Z"
    }
  ],
  "nextCursor": null
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid request"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "API key required"
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient workspace permissions",
    "details": {
      "code": "INSUFFICIENT_WORKSPACE_ROLE"
    }
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Not found"
  }
}
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "API rate limit exceeded",
    "details": {
      "retryAfter": "2026-01-01T00:00:30.000Z"
    }
  }
}
{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  }
}
{
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "message": "Service temporarily unavailable"
  }
}
GETGet Custom ToolPATCHUpdate Custom Tool