Get object type detail

GET

/v1/object-types/{api_name}

const url = 'https://api.aerandil.com/v1/object-types/example';
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/example \
  --header 'Authorization: Bearer <token>'

Schema-discovery detail — returns the summary fields plus the full property list, each property carrying its typed [DataTypeSummary]. SDKs can render forms or run client-side validation from the response without parsing the OpenAPI document.

Authorizations

aerandil_oauth
objects:read

Parameters

Path Parameters

api_name

required

string

API name of the object type (e.g. hospitality.reservation).

Responses

200

Object type detail including every declared property.

application/json

ObjectTypeSummary extended with the full property list. SDKs can render forms or run client-side validation without parsing the OpenAPI document.

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

properties

required

Array<object>

object

api_name

required

string

data_type

required

One of: discriminator: kind

object

kind

required

string

Allowed value: bool

Allowed values: bool

description

string

nullable

display_name

required

string

indexed

required

boolean

markings

required

Marking api_names (e.g. pii, payment_data) that gate row-level access. Empty when no markings apply.

Array<string>

required

required

boolean

Example

{
  "scope_levels": [
    "tenant"
  ],
  "status": "active",
  "properties": [
    {
      "data_type": {
        "kind": "bool"
      }
    }
  ]
}

404

No object type with that api_name.