Staff
Get a staff member
Returns a staff member by its identifier.
staff:readstaff:read- 120/min
- Server annotation: Read-only
- Server annotation: Idempotent
Result
generated from the schema
The projection is the same as the listing, and that is deliberate: the internal record carries personal and employment data —emergency contact, contract type and hours, internal and external cost, platform role— that is not published to an integrator. This operation exists to resolve an identifier without paginating the whole listing, not to widen what is seen of a person.
Arguments
Staff member identifier.
Limits: min length 1
Result
On success the result carries structuredContent with data and meta. These are the attributes of data.
Show the attributes of data
Unique staff member identifier.
Full name.
Staff member type.
Available options: employee, freelancer, contractor
Identifier of the collection it belongs to; null if it is in none.
Collection path it belongs to; null if not applicable.
true if they hold a driving licence.
true if they appear in the planner of the account.
External reference for matching with third-party systems; null if it has none.
Creation date in ISO 8601 UTC; null if not recorded.
Last modification date in ISO 8601 UTC; null if not recorded.
An error is a result with isError: true and the problem in content[0].; there is no structuredContent. See Errors.
The same operation by REST
This tool runs GET /api/v1/staff/{staffId}.
Related pages
Link to this section: Related pagesStaff
Get a staff member
Returns a staff member by its identifier.
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?