Skip to content
aerandil.com
GitHub

Read Staff member

GET
/v1/object-types/hospitality.staff_member/objects/{id}
curl --request GET \
  --url https://api.aerandil.com/v1/object-types/hospitality.staff_member/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

An employee. Linked to a property; for chains a single staff member can be a manager across multiple properties via additional links in higher-level extensions.

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).

Query Parameters

Section titled “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

Section titled “Responses”

200

Section titled “200”

Object found.

Media typeapplication/json
object
created_at
required
string format: date-time
id
required
string format: uuid
object_type
required
Allowed value: hospitality.staff_member
properties
required
object
active
required
Active
boolean
comp_authority_summary
Staff member comp authority summary

Resolved comp authority summary (cache)

object
can_comp_room_night
boolean
can_comp_spa
boolean
daily_combined_limit
object
amount
required
string format: decimal
currency
required
string format: iso-4217
last_computed
string format: date-time
per_incident_limit
object
amount
required
string format: decimal
currency
required
string format: iso-4217
contracted_weekly_hours
The hours a week the staff member is contracted for (more than 0, at most 168) — what the pacing report's percentage_worked is of
string format: decimal
department
Department
string
discipline
Discipline
string
Allowed values: front_office food_beverage culinary bar housekeeping engineering spa wellness_clinical wellness_coaching sales revenue management other
email
Email
string
employee_id
Employee ID
string
family_name
Family name
string
given_name
Given name
string
handset_passcode_hash
Handset PIN hash (Argon2id, PHC string)
string
identity_subject
Identity-provider subject (SSO)
string
most_recent_hire_date
Most recent hire date
string format: date
pathway_stage_code
Pathway stage code (operator vocabulary)
string
push_topics
The push topics the staff member hears; absent = cleaning_tasks and faults (the nudges every handset has had), and the fault topics (urgent, postponed, delegated) only when named
Array<string>
Allowed values: cleaning_tasks faults urgent_faults postponed_faults delegated_faults stock
role
required
Role
string
Allowed values: front_office_agent front_office_supervisor concierge bell housekeeper housekeeping_supervisor engineer food_beverage_server food_beverage_manager chef spa_therapist spa_manager reservations_agent revenue_manager sales_manager manager_on_duty general_manager owner other runner
sort_preferences
Staff member sort preferences

The staff member’s own order for a board, one entry per board — wins over the house’s pattern in board_sort

Array<object>
object
board
required
string
Allowed values: housekeeping_sheet housekeeping_rack work_orders pacing
keys
required
Array<object>
object
direction
required
string
Allowed values: asc desc
key
required
string
Allowed values: priority room_number floor task_type status due_at credits arrival_time departure_time pending_credits target_percent name
values
Array<string>
tenure_computed_at
Tenure refresh timestamp
string format: date-time
tenure_years_at_current_property
Tenure years at current property (projection)
string format: decimal
tenure_years_lifetime
Tenure years lifetime (projection)
string format: decimal
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.staff_member",
  "properties": {
    "discipline": "front_office",
    "push_topics": [
      "cleaning_tasks"
    ],
    "role": "front_office_agent",
    "sort_preferences": [
      {
        "board": "housekeeping_sheet",
        "keys": [
          {
            "direction": "asc",
            "key": "priority"
          }
        ]
      }
    ]
  },
  "scope": {
    "level": "tenant"
  }
}

Headers

Section titled “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

Section titled “404”

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