Search Checklist template

POST

/v1/object-types/hospitality.checklist_template/search

const url = 'https://api.aerandil.com/v1/object-types/hospitality.checklist_template/search';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"branch":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","cursor":"example","filters":[{"property":"id","type":"eq","value":"example"}],"limit":1,"order":"asc","property_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","scope":{"level":"tenant"},"sort_by":"created_at"}'
};

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

curl --request POST \
  --url https://api.aerandil.com/v1/object-types/hospitality.checklist_template/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "cursor": "example", "filters": [ { "property": "id", "type": "eq", "value": "example" } ], "limit": 1, "order": "asc", "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "scope": { "level": "tenant" }, "sort_by": "created_at" }'

Search for instances. Filters eq, contains, gte and lte AND-compose; or / not are additive follow-ups. Pages with an opaque cursor; the +1 fetch returns has_more without a second round-trip. Ordered by sort_by (default created_at) in order (default ascending), id breaking ties; rows with no value for a property key sort last.

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

Request Body^required

application/json

object

branch

Optional open-branch id. Search composes that branch’s copy-on-first-write overlay instead of main, so a preview reads its own hypothetical writes. Omit to read main.

string format: uuid

cursor

Opaque cursor from a prior response’s next_cursor. Pass back verbatim; do not introspect.

string

filters

Conjunctive list of predicates. Empty or omitted matches every row in scope, capped by limit.

Array

One of:

object

property

required

Allowed value: id

type

required

Allowed value: eq

value

required

string

limit

Page size. Server defaults to 50, silently clamps at 500 (AIP-158 §3).

integer

>= 1 <= 500

order

Direction of sort_by: asc (oldest / smallest first) or desc. A cursor is bound to the sort_by and order it was minted under; another pair is refused (422).

string

default: asc

Allowed values: asc desc

property_id

The house a desk stands in: keeps this property’s rows (property- or venue-scoped there) and every row scoped to no property (tenant, brand, portfolio), and drops a sibling house’s — the meaning property_id has on the event tail.

string format: uuid

scope

One of: discriminator: level

object

level

required

string

Allowed value: tenant

Allowed values: tenant

sort_by

What the page is ordered by: the row’s created_at or updated_at, or a property whose type orders — strings, enums and dates as text, ints, decimals and durations as numbers, datetimes as instants. Rows with no value sort last in either direction. A property the caller is not cleared to read is refused (403).

string

default: created_at

Allowed values: created_at updated_at id name applies_to_task_type applies_to_area_kind status retired_at

Responses

200

Search results, ordered by (sort_by, id) in the requested order (ascending by default).

application/json

object

data

required

Array<object>

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

has_more

required

boolean

next_cursor

Cursor for the next page; omitted when the result set is exhausted.

string

Example

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

422

Validation error — unknown property or filter type mismatch.

Search Checklist template

Authorizations

Request Bodyrequired

Responses

200

Example

422

Request Body^required