Schedule — read
list_shifts read
Section titled “list_shifts ”List the brand’s configured shifts: name, weekdays, start/end time, slot interval, max covers per slot, turn times, notes. Use this to answer schedule questions or to size a reservation against a shift’s capacity.
Required scope: schedule.read
| Parameter | Type | Required | Description |
|---|---|---|---|
brand |
string | no | Brand slug. Optional in JWT mode; required in multi-brand API-key mode. |
day |
enum | no | Optional weekday filter (e.g. “Fri”). When set, only shifts that run on that day are returned. |
get_todays_shifts read
Section titled “get_todays_shifts ”Convenience wrapper around list_shifts: returns only the shifts running today (in the brand’s local timezone). Useful when an operator asks ‘what’s running tonight?’ without specifying a day.
Required scope: schedule.read
| Parameter | Type | Required | Description |
|---|---|---|---|
brand |
string | no | Brand slug. Optional in JWT mode; required in multi-brand API-key mode. |