Skip to content
aerandil.com
GitHub

Search Staff member

POST
/v1/object-types/hospitality.staff_member/search
curl --request POST \
  --url https://api.aerandil.com/v1/object-types/hospitality.staff_member/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "cursor": "example", "filters": [ { "property": "employee_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.

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”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/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: employee_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 employee_id given_name family_name email handset_passcode_hash identity_subject role department discipline pathway_stage_code most_recent_hire_date tenure_years_at_current_property tenure_years_lifetime tenure_computed_at contracted_weekly_hours

Responses

Section titled “Responses”

200

Section titled “200”

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

Media typeapplication/json
object
data
required
Array<object>
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
has_more
required
boolean
next_cursor

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

string
Example
{
  "data": [
    {
      "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"
      }
    }
  ]
}

422

Section titled “422”

Validation error — unknown property or filter type mismatch.