List Custom Tools

List code-backed custom tools defined in a workspace. Legacy personal tools are excluded. The bounded workspace set uses the standard cursor envelope with nextCursor always null; there is no second page to fetch.

GET/api/v2/custom-tools

Authorization

apiKey
X-API-Key<token>

Your Sim API key, personal or workspace-scoped. Generate one from the Sim dashboard under Settings > API Keys. A workspace API key is not accepted everywhere: operations that act on behalf of a specific human — administrative reads, secret access, and irreversible or governance-affecting writes — always reject it, whatever role the key carries. Each such operation says so in its own description, and the rejection surfaces as 403 unless the operation conceals unauthorized resources, in which case it is reported as 404. Use a personal API key for those.

In: header

Query Parameters

workspaceId*string

Workspace that owns the custom tool.

Length1 <= length
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"

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"
{
  "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": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}