Skip to main content

Get Version

Retrieve a specific version of a schema graph class by class ID and version number. Requires read scope.

GET/v1/schema-graph/classes/{id}/versions/{version}

Response

Response fields

idstringVersion UUID.
schema_class_idstringParent schema class UUID.
version_numberintegerVersion number.
json_schemaobjectJSON Schema definition for this version.
field_idsarrayArray of field registry UUIDs included in this version.
created_atstringISO 8601 creation timestamp.

Response

{
  "id": "ver-uuid-2",
  "schema_class_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "version_number": 2,
  "json_schema": {
    "type": "object",
    "properties": {
      "invoice_number": { "type": "string" },
      "vendor": { "type": "string" }
    }
  },
  "field_ids": ["field-uuid-1", "field-uuid-2"],
  "created_at": "2024-08-15T00:00:00.000Z"
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
404not_foundNo schema class with this ID exists for your organization, or the requested version number does not exist.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

Related

List Versions