Get a JSON schema

Returns the JSON Schema for a GOBL type. Use the bundle query parameter to get a self-contained schema with all dependencies inlined.

GET /schemas/{path}

Get a JSON schema

cURL

curl --request GET \
  --url https://gobl.dev/v0/schemas/{path}

404

{
  "code": 422,
  "key": "<string>",
  "message": "<string>",
  "faults": [
    {
      "properties": [
        "<string>"
      ],
      "description": "<string>"
    }
  ]
}

Path Parameters

path · string · required

Query Parameters

bundle · boolean

When present, returns a self-contained schema with all transitive $ref dependencies resolved into $defs.

Response

200

application/json

JSON Schema document