Skip to main content
GET
Get a tool
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/get?id= accepts a tool component id, legacy id, or toolId. It returns active and deprecated tools only. Missing, malformed, draft, archived and unknown ids return 404 resource_missing.

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

Response

Tool detail

data
object
required
meta
object
required