v1

latestOpenAPI 3.1.02026-07-1342112262.5 KB

Staff

Fetch a staff member

Required scope: business/staff:read

get/v1/staff/{staff_id}

Path parameters

staff_idstring required

The unique identifier of the staff member.

Response

Successful Response

idstring required

The unique identifier of the staff member.

staff_numberstring nullable

The staff number set by an external system, such as a point-of-sale integration, used to reconcile this staff member to that system. null when no external staff number has been recorded.

role'administrator' | 'custom' | 'manager' | 'staff_member' | 'supervisor' required

status'active' | 'inactive' required

first_namestring nullable required

The first name of the staff member.

last_namestring nullable required

The last name of the staff member.

created_atstring date-time required

The date and time the staff member was added to the business in ISO 8601 format.

updated_atstring date-time required

The date and time the staff member was last updated in ISO 8601 format.

deleted_atstring date-time nullable

The date and time the staff member was removed from the business in ISO 8601 format, or null if they are still active.

Example response

{
  "created_at": "2024-11-19T15:27:02+00:00",
  "first_name": "Jane",
  "id": "1739522545-45b6b5d8-897f-4a00-86f4-a7e9b315934f",
  "last_name": "Doe",
  "role": "manager",
  "staff_number": "1234",
  "status": "active",
  "updated_at": "2024-11-19T15:27:02+00:00"
}