Read Checklist template

GET

/v1/object-types/hospitality.checklist_template/objects/{id}

const url = 'https://api.aerandil.com/v1/object-types/hospitality.checklist_template/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
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/hospitality.checklist_template/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

The list an attendant ticks — or a supervisor inspects against — for one housekeeping task type, optionally one room type (checklist_template_for_room_type). A brand standard (checklist_template_at_brand) or the house’s own (checklist_template_at_property); a task resolves the most specific active template: the house’s for its room type, the house’s for every room, the brand’s for its room type, the brand’s for every room. required_for_completion makes complete_housekeeping_task refuse until a checklist_result for this template is recorded against the task — hubOS’s ‘checklist for inspection’ building toggle, per list instead of per building. One active template per (scope, task type, room type): re-defining one revises its items in place. A public-area task type’s list may name a kind of area instead (applies_to_area_kind, 2026-10-14): an area’s task resolves the list for its kind before the list for every area, at the house and then the brand.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.checklist_template:read

Parameters

Path Parameters

required

string format: uuid

Object id (UUID v7, server-generated at create time).

Query Parameters

branch

string format: uuid

Read through an open branch’s copy-on-first-write overlay view instead of the canonical (main) plane. Does not compose with as_of (422). The branch must exist under the caller’s tenant.

Responses

200

Object found.

application/json

object

created_at

required

string format: date-time

required

string format: uuid

object_type

required

Allowed value: hospitality.checklist_template

properties

required

object

applies_to_area_kind

The kind of public area the list is for (on a public-area task type only); absent: every area, or a room's list

string

Allowed values: lobby corridor lift stairwell pool gym spa_area restaurant_floor toilets back_of_house exterior other

applies_to_task_type

required

The housekeeping task type the list is for

string

Allowed values: stayover departure vacant_pickup deep_clean turndown inspection public_area_clean public_area_inspection minibar laundry

required

Checklist template id

string

items

required

Checklist template items

The items, in the order the attendant meets them

Array<object>

object

code

required

string

kind

required

string

Allowed values: check photo count text

label

required

string

name

required

What the list is called on the handset

string

required_for_completion

required

Whether the task cannot complete without a recorded result

boolean

retired_at

When the template was retired

string format: date-time

status

required

Active (resolves onto tasks) or retired

string

Allowed values: active retired

provenance

Per-property source attribution and pins. An entry under properties means the property’s current value came from that source (on the source’s own clock, source_updated_at); an entry under pins is a human override protecting the property from sourced writes.

object

pins

object

key

additional properties

object

pinned_at

string format: date-time

pinned_by

object

reason

required

string

properties

object

key

additional properties

object

external_id

string

recorded_at

required

string format: date-time

source

required

string

source_updated_at

string format: date-time

stream

string

scope

required

One of: discriminator: level

object

level

required

string

Allowed value: tenant

Allowed values: tenant

tenant_id

required

string format: uuid

updated_at

required

string format: date-time

version

required

integer

>= 1

Example

{
  "object_type": "hospitality.checklist_template",
  "properties": {
    "applies_to_area_kind": "lobby",
    "applies_to_task_type": "stayover",
    "items": [
      {
        "kind": "check"
      }
    ],
    "status": "active"
  },
  "scope": {
    "level": "tenant"
  }
}

Headers

ETag

string

/^"\d+"$/

Quoted strong validator (RFC 7232 §2.3) carrying the object’s monotonic version. Informational on the read path — object mutation goes through typed actions on /v1/actions/{action}/apply, not raw CRUD.

404

No object with that id (or soft-deleted).