Staff
Check staff availability
Returns, for each staff member (the whole team, or the ones selected by staffIds, tags, collectionId or search), whether they have commitments overlapping the queried window and which ones, typed: order lines, internal services, declared absences and blocking incidents.
staff:readstaff:read- 120/min + 30/min availability
- Server annotation: Read-only
- Server annotation: Idempotent
Result
generated from the schema
Unlike /api, the response is NOT stock arithmetic: a person has no pool, they are either free or on a specific job. A requested identifier that does not exist comes back as a per-item error. Idempotent query (POST because of the structured body). Shares the availability quota of 30 req/min.
Arguments
Start of the window to check (ISO 8601 with offset).
End of the window to check (ISO 8601 with offset); must be later than startDate.
Only resources in this collection.
Limits: min length 1, max length 100
Free-text search on the name.
Limits: min length 1, max length 200
Restrict the answer to these staff members (1-100). An identifier that does not exist comes back as a per-item error.
Limits: min 1 items, max 100 items, each min length 1, each max length 100
Result
On success the result carries structuredContent with data and meta. These are the attributes of data.
An error is a result with isError: true and the problem in content[0].; there is no structuredContent. See Errors.
Sample prompts
Which crew members are free on 20 January?
The same operation by REST
This tool runs POST /api/v1/staff/availability.
Related pages
Link to this section: Related pagesStaff
Check staff availability
Returns, for each staff member (the whole team, or the ones selected by
staffIds,tags,collectionIdorsearch), whether they have commitments overlapping the queried window and which ones, typed: order lines, internal services, declared absences and blocking incidents.Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with
isError: trueand the problem in the first text block. Branch on itscode.
Was this page helpful?