Read Staff shift

GET

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

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

Read an existing instance.

One worked (or in-progress) shift. department and management are stamped at clock-in — a cross-department day is two shifts, and a later promotion does not rewrite history. Hours are computed at clock-out (actual_end - actual_start minus unpaid break) and report under the property-local business_date of actual_start. Immutable post-close except voided (mis-punch correction: void + re-record).

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.staff_shift: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.staff_shift

properties

required

object

actual_end

Actual end

string format: date-time

actual_start

Actual start

string format: date-time

business_date

Business date

string format: date

credit_target

Housekeeping credits the attendant is expected to clean this shift (zero or more)

string format: decimal

department

USALI 12 Schedule 15 department

string

Allowed values: rooms food_beverage health_club_spa golf parking minibar it_services retail other_operated minor_operated administrative_general information_telecom_systems sales_marketing property_ops_maintenance utilities

required

Shift id

string

management

Management

boolean

notes

Notes

string

scheduled_end

Scheduled end

string format: date-time

scheduled_start

Scheduled start

string format: date-time

source

required

Source

string

Allowed values: timeclock payroll_import manual

status

required

Status

string

Allowed values: open closed voided

unpaid_break_minutes

Unpaid break minutes

integer

worked_hours

Worked hours

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_shift",
  "properties": {
    "department": "rooms",
    "source": "timeclock",
    "status": "open"
  },
  "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).