Skip to main content

Get Class

Retrieve one schema graph class by UUID: its canonical name, status, current version pointer, and links to the full version history. Requires read scope.

Retrieve a single schema graph class by its UUID: one discovered document type with its canonical name, status, and a pointer to its current version. Use this to inspect a specific document type's metadata before drilling into its field structure via the version history.

A common workflow is: list classes to find the document type you care about, fetch it here to read current_version_id, then follow links.versions to see how its field structure evolved. To review proposed ontology changes for the class, query GET /v1/schema-graph/diffs?schema_class_id={id}.

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

curl

Response

Response fields

idstringSchema class UUID.
schema_classstringCanonical class name.
document_type_idstring | nullAssociated document type UUID.
descriptionstring | nullOptional description.
current_version_idstring | nullUUID of the current active version.
statusstringClass status.
created_atstringISO 8601 creation timestamp.
updated_atstringISO 8601 last update timestamp.
links.selfstringURL to this class.
links.versionsstringURL to this class's version history.

Response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "schema_class": "Invoice",
  "document_type_id": "doc-type-uuid",
  "description": "Standard invoice schema class",
  "current_version_id": "ver-uuid-3",
  "status": "active",
  "created_at": "2024-08-01T00:00:00.000Z",
  "updated_at": "2024-09-14T00:00:00.000Z",
  "links": {
    "self": "/v1/schema-graph/classes/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "versions": "/v1/schema-graph/classes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/versions"
  }
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
404not_foundNo schema class with this ID exists for your organization.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.
The class object carries metadata only. The field structure lives in versions: follow links.versions and read the json_schema of the version matching current_version_id.

Related

List Classes
List Versions
List Diffs