Operations

Staff member

Staff member, with the minimum projection needed for planning.

Schemas: StaffMemberDto

{
  "id": "id_8f2a1c",
  "fullName": "Example",
  "staffType": "employee",
  "collectionId": "string",
  "collectionName": "Example",
  "hasDrivingLicense": true,
  "showInPlanner": true,
  "externalRef": "string",
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z"
}

Generated from the schema

A member of the team, with the minimum projection needed for planning: name, type of engagement, collection, driving license and external reference. Contact, identity, employment, payroll and platform access data are not published, neither when reading nor when writing. Staff are bounded to the subscription that owns the key.

Attributes

idstring

Unique staff member identifier.

fullNamestring

Full name.

staffTypestring

Staff member type.

Available options: employee, freelancer, contractor

collectionIdstring | null

Identifier of the collection it belongs to; null if it is in none.

collectionNamestring | null

Collection path it belongs to; null if not applicable.

hasDrivingLicenseboolean

true if they hold a driving licence.

showInPlannerboolean

true if they appear in the planner of the account.

externalRefstring | null

External reference for matching with third-party systems; null if it has none.

createdAtstring<date-time> | null

Creation date in ISO 8601 UTC; null if not recorded.

updatedAtstring<date-time> | null

Last modification date in ISO 8601 UTC; null if not recorded.

Values

staffType: employee, freelancer, contractor

Returned by

GET /api/v1/staff — List staff
GET /api/v1/staff/{staffId} — Get a staff member

Modified by

POST /api/v1/staff — Create a staff member
PATCH /api/v1/staff/{staffId} — Update a staff member

Was this page helpful?