Get a document schema

Retrieve a Terminal49 document schema for an extraction output, including the schema version and the structured payload contract for parsed fields.

GET /document_schemas/{id}

Get a document schema

cURL

curl --request GET \
  --url https://api.terminal49.com/v2/document_schemas/{id} \
  --header 'Authorization: <api-key>'

200

{
  "data": {
    "id": "<string>",
    "attributes": {
      "document_type": "<string>",
      "label": "<string>",
      "schema_version": "<string>",
      "full_version": "<string>",
      "current": true,
      "draft": true,
      "active_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "schema_payload": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "links": {
      "self": "<string>"
    }
  },
  "links": {
    "self": "<string>"
  }
}

Beta Feature - This endpoint is currently in beta. The API is stable, but the schema and behavior may evolve based on feedback.

Authorizations

Authorization · string · header · required

Use a Terminal49 API key in the Authorization header with the Token prefix.

Authorization: Token YOUR_API_KEY

Path Parameters

id · string · required

Schema id in full-version format, e.g. commercial_invoice@2026-03-23.

Response

200

application/json

OK

data · Document Schema · object

Show child attributes

links · link · object

Show child attributes