Skip to main content
GET
List tool sets
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

GET /api/v2/tools/listSets returns builtin and active workspace tool sets. Workspace membership includes active and deprecated catalog tools only; counts, names and maximum risk are computed from those visible members. Catalog reads are bounded to 5,000 stored tool and tool-set rows each. If either read reaches that bound or cannot project every stored row, this operation fails instead of returning incomplete counts. A complete empty catalog returns an empty list. Workspace tool sets are created, changed and deleted with createToolSet, updateToolSet and deleteToolSet.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Query Parameters

limit
integer

Items per page, 1 to 1000; a larger value is a 400 too_big. Omitted, the page is the whole list. The list is read whole.

Required range: 1 <= x <= 1000
cursor
string

The previous page's meta.nextCursor; any other value is 400.

Minimum string length: 1

Response

Tool set list

data
object[]
required
meta
object
required

A list page's continuation. While hasMore is true, nextCursor is a string: pass it as cursor for the next page. hasMore: false ends the list; with truncated: true, more exist past what this list reads, and no cursor reaches them.