Skip to main content

Aliases

List schema graph aliases: mappings from raw extracted field names to their canonical field names within a schema class, produced during field resolution.

A schema alias maps a raw extracted field name to the canonical field name it resolves to within a schema class. Documents label the same concept many ways ("Invoice No.", "Inv #", "Rechnungsnummer"); field resolution clusters those variants onto one canonical field, and each variant is recorded as an alias row. This endpoint lists all alias mappings for your organization, newest first.

Aliases are populated automatically from the field-resolution clusters: when a raw field name is bound to a canonical registry concept, an alias row links alias_name to canonical_name (and to the canonical field's registry UUID). Use the list to audit how variant labels resolve, to debug why two spellings of a field ended up on the same column, or to export a normalization dictionary for your own tooling.

GET/v1/schema-graph/aliases

curl

Response

Response fields

dataarrayArray of alias objects.
data[].idstringAlias UUID.
data[].customer_idstringOrganization UUID.
data[].schema_class_idstring | nullSchema class the alias belongs to.
data[].alias_namestringThe raw extracted field name before normalization.
data[].canonical_namestringThe canonical field name this alias resolves to.
data[].canonical_field_idstring | nullField registry UUID of the canonical field.
data[].sourcestringHow the alias was created, e.g. resolution or manual.
data[].created_atstringISO 8601 creation timestamp.

Response

{
  "data": [
    {
      "id": "alias-uuid-1",
      "customer_id": "org-uuid",
      "schema_class_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "alias_name": "Inv #",
      "canonical_name": "invoice_number",
      "canonical_field_id": "field-uuid-1",
      "source": "resolution",
      "created_at": "2024-08-20T00:00:00.000Z"
    }
  ]
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.
Aliases map field names, not document types. If you need to see which fields a raw label bound to across your documents, cross-reference canonical_field_id with the field registry via GET /v1/fields/{id}.