Skip to main content

List Classes

List all schema graph classes in the versioned ontology of document classes discovered across your workspace with field counts and version info.

The schema graph is a versioned ontology of document classes discovered across your workspace. Each class captures a document type's canonical fields. The API exposes versioned classes, diffs proposed between versions (with approve/reject workflow), inter-class edges, aliases, and a D3-compatible visualization payload.

GET/v1/schema-graph/classes

Response

Response fields

dataarrayArray of schema class objects.
data[].idstringSchema class UUID.
data[].schema_classstringCanonical class name (e.g. Invoice, Purchase Order).
data[].document_type_idstring | nullAssociated document type UUID.
data[].descriptionstring | nullOptional description of the class.
data[].current_version_idstring | nullUUID of the current active version.
data[].statusstringClass status (e.g. active, archived).
data[].created_atstringISO 8601 creation timestamp.
data[].updated_atstringISO 8601 last update timestamp.
data[].links.selfstringURL to this class.
data[].links.versionsstringURL to this class's version history.

Response

{
  "data": [
    {
      "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.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

Related

Get Class
List Versions