Fetch the full OpenAPI 3.0 schema

Operation

GET /schema

Returns the hand-maintained OpenAPI document that describes this API. Useful for API clients that want to generate bindings or validate payloads.

Operation ID: getOpenApiSchema · Tags: Meta

Parameters

This operation does not define any parameters.

Request Body

No request body is defined for this operation.

Responses

Content Types

application/json

{
  "description": "OpenAPI 3.0 document",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "description": "OpenAPI 3.0 root object",
        "additionalProperties": true
      }
    }
  }
}

API Playground

Run this GET request with your API key, or open it in a new tab. Path uses sample IDs where the OpenAPI path has {parameters}. Sign in to enable live testing with your API key.

Action	Method	Endpoint	Description
Fetch the full OpenAPI 3.0 schema	`GET`	`/api/v1/schema`	OpenAPI operationId: getOpenApiSchema.

GET /api/v1/schema OpenAPI