Skip to main content

Aliases

List all class aliases — alternative names that map to canonical class IDs in the schema graph ontology.

GET/v1/schema-graph/aliases

Response

Response fields

dataarrayArray of alias objects.
data[].idstringAlias UUID.
data[].customer_idstringOrganization UUID.
data[].aliasstringAlternative name for the class.
data[].schema_class_idstringUUID of the canonical schema class this alias maps to.
data[].created_atstringISO 8601 creation timestamp.

Response

{
  "data": [
    {
      "id": "alias-uuid-1",
      "customer_id": "org-uuid",
      "alias": "Bill",
      "schema_class_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "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.

Related

List Classes