Skip to main content
GET
/
document_schemas
/
{id}
Get a document schema
curl --request GET \
  --url https://api.terminal49.com/v2/document_schemas/{id} \
  --header 'Authorization: <api-key>'
import requests

url = "https://api.terminal49.com/v2/document_schemas/{id}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.terminal49.com/v2/document_schemas/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.terminal49.com/v2/document_schemas/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.terminal49.com/v2/document_schemas/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.terminal49.com/v2/document_schemas/{id}")
  .header("Authorization", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.terminal49.com/v2/document_schemas/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": "<string>",
    "type": "document_schema",
    "attributes": {
      "document_type": "<string>",
      "label": "<string>",
      "schema_version": "<string>",
      "full_version": "<string>",
      "current": true,
      "draft": true,
      "active_at": "2023-11-07T05:31:56Z",
      "schema_format": "json_schema",
      "description": "<string>",
      "schema_payload": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "links": {
      "self": "<string>"
    }
  },
  "links": {
    "self": "<string>"
  }
}
{
  "errors": [
    {
      "title": "<string>",
      "detail": "<string>",
      "source": {
        "pointer": "<string>",
        "parameter": "<string>"
      },
      "code": "<string>",
      "status": "<string>",
      "meta": {}
    }
  ]
}
{
  "errors": [
    {
      "status": "404",
      "title": "Not Found",
      "detail": "Couldn't find DocumentSchema with 'id'=unknown@2026-03-23"
    }
  ]
}
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

OK

data
Document Schema · object