Skip to main content
GET
List a tool's versions
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/listVersions lists the versions of an active or deprecated tool; any other tool is 404 resource_missing, as for getTool. The version’s configuration, sandbox commands and schemas are never returned. Versions come newest minted first, a page at a time (limit 1–100, default 100). While meta.hasMore is true, pass meta.nextCursor as cursor with the same other parameters for the next page. A page may hold fewer versions than limit while more remain; the list never answers meta.partial.

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.

Path Parameters

toolId
string
required

Query Parameters

limit
integer
default:100

Items per page, 1 to 100 (default 100); a larger value is a 400 too_big. A page may hold fewer items than limit while meta.hasMore is true; continue with meta.nextCursor.

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

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

Minimum string length: 1

Response

Tool versions

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.