Skip to content
aerandil.com
GitHub

Traverse from Housekeeping task

POST
/v1/object-types/hospitality.housekeeping_task/objects/{id}/traverse
curl --request POST \
  --url https://api.aerandil.com/v1/object-types/hospitality.housekeeping_task/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/traverse \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "as_of": "2026-04-15T12:00:00Z", "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "cursor": "example", "direction": "out", "limit": 1, "link_type": "hospitality.link.checklist_result_for_task", "role": "example" }'

RPC-shaped traversal. Pick the edge by (link_type, direction) or by role — the registry resolves a role name (e.g. managed_by, direct_reports) to the underlying link side. link_type wins when both are present.

A unit of housekeeping work attached to a room: a stayover clean, a departure clean, a deep clean, a turndown, an inspection. Minted by generate_housekeeping_tasks (which derives the day’s board from occupancy + due-outs and stamps a generation_key so re-runs converge) or by create_housekeeping_task for ad-hoc work (origin says which, and marks a failed inspection’s re-clean). Assignment is the housekeeping_task_assigned_to edge; the per-attendant task sheet is a projection over (assignee, business_date), never a second object to keep in sync. A public area’s work (2026-10-14) is the same object linked housekeeping_task_for_area instead of to a room — a task is for a room or an area, never both, and the public_area_* types are an area’s alone; and a task may be assigned to a worker_group (housekeeping_task_assigned_to_group) instead of a person, until a member starts it. A task is also a request (2026-10-15): requested_by says who asked (a guest’s request links the stay, housekeeping_task_requested_by_stay), due_at when it is due, and it carries a thread of notes (housekeeping_task_entry). area_id, assignee_id and group_id copy the area, person and group edges onto the row.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

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

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

Body for POST .../traverse. At least one of link_type or role MUST be supplied — the server returns 422 missing_traversal_target when both are absent. link_type wins when both are set.

object
as_of

RFC3339 temporal window: return neighbours whose edge was in effect at this instant ([effective_from, effective_to)) instead of now.

string format: date-time
branch

Traverse through an open branch’s overlay view instead of the canonical (main) plane. Does not compose with as_of (422).

string format: uuid
cursor
string
direction

Edge direction. Optional when the binding is asymmetric.

Allowed values: out in
limit
integer
>= 1 <= 500
link_type

API name of the link type to traverse. Narrowed to link types that bind the source. Wins over role.

Allowed values: hospitality.link.checklist_result_for_task hospitality.link.housekeeping_task_assigned_to hospitality.link.housekeeping_task_assigned_to_group hospitality.link.housekeeping_task_entry_for_task hospitality.link.housekeeping_task_for_area hospitality.link.housekeeping_task_for_room hospitality.link.housekeeping_task_from_inspection hospitality.link.housekeeping_task_from_triage hospitality.link.housekeeping_task_requested_by_stay hospitality.link.inspection_rates_task hospitality.link.pattern_clusters_housekeeping_task hospitality.link.stock_movement_for_housekeeping_task
role

Link-side role name (e.g. managed_by, direct_reports). Mutually substitutable with link_type — the registry resolves the role to its underlying link and direction.

string

Responses

Section titled “Responses”

200

Section titled “200”

Neighbours along the resolved link.

Media typeapplication/json
object
data
required
Array<object>
object
created_at
required
string format: date-time
id
required
string format: uuid
object_type
required
string
properties
required
object
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
direction
required
Allowed values: out in
has_more
required
boolean
link_type
required
string
next_cursor
string
Example
{
  "data": [
    {
      "scope": {
        "level": "tenant"
      }
    }
  ],
  "direction": "out"
}

404

Section titled “404”

No object with that id, or link type unknown.

422

Section titled “422”

Validation error — must supply link_type or role.