List object types

GET

/v1/object-types

const url = 'https://api.aerandil.com/v1/object-types';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.aerandil.com/v1/object-types \
  --header 'Authorization: Bearer <token>'

Schema-discovery surface — return every registered [ObjectTypeDef] in compact summary form. Companion to the OpenAPI document at /v1/openapi.json: both expose the registry, but this endpoint is friendlier to runtime introspection (no schema-walk needed) and ships the display_name/description/markings operator fields that the per-type JSON Schemas don’t surface. Sorted by api_name ascending. Returns next_page_token: null in v1 — ontology size stays under the pagination threshold.

Authorizations

aerandil_oauth
objects:read

Responses

200

Sorted summary list of every registered object type.

application/json

object

data

required

Array<object>

object

api_name

required

string

description

string

nullable

display_name

required

string

markings

required

Row-level markings applied to every instance (e.g. pii, payment_data).

Array<string>

primary_key

required

API name of the property that serves as the type’s primary key.

string

property_count

required

integer

scope_levels

required

Levels of the tenancy hierarchy at which instances of this type are allowed to live.

Array

Allowed values: tenant brand portfolio property venue

status

required

Lifecycle state of the type definition.

Allowed values: active deprecated

title_property

API name of the property used for human-readable titles (e.g. an SDK’s .toString() equivalent).

string

nullable

next_page_token

Opaque cursor for the next page (AIP-158). Reserved for future growth; v1 returns null because the registry size is bounded.

string

nullable

Example

{
  "data": [
    {
      "scope_levels": [
        "tenant"
      ],
      "status": "active"
    }
  ]
}