Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-2473111182.6 KB
Staff

Retrieve a staff

Get a staff member for the specified business id, branch id and staff id

get/api/business/{businessId}/branch/{branchId}/staff/{staffId}

Path parameters

businessIdstring required
branchIdstring required
staffIdstring required

Response

Specified staff retrieved

staffIdstring
branchIdstring
staffCategoryIdstring
userIdstring
staffCategoryNamestring
firstNamestring
lastNamestring
birthDatestring date
startDatestring date
selfEmployedboolean
archivedboolean
mobilestring
emailstring
genderstring
notesstring
onlineProfilestring
hideFromOnlineBookingsboolean
hideFromAppointmentScreenboolean
imageUrlstring
taxNumberstring

The tax registration number for self-employed staff members (VAT, GST, Tax Number, etc. depending on territory)

payrollNumberstring
disqualifiedServicesstring[]

The list of disqualified serviceIds for a staff member

Example response

{
  "staffId": "staff123",
  "branchId": "SE-J0emUgQnya14mOGdQS",
  "staffCategoryId": "l7fizkAS1JA8TzMoO4iliA",
  "userId": "TyfizkAS1JA8TzMoO4iliA",
  "staffCategoryName": "Administrator",
  "firstName": "John",
  "lastName": "Doe",
  "mobile": "01321312312",
  "email": "user@gmail.com",
  "gender": "female",
  "notes": "Same sample notes",
  "onlineProfile": "Online Profile Desc",
  "hideFromOnlineBookings": true,
  "hideFromAppointmentScreen": true,
  "taxNumber": "IE1234567T",
  "payrollNumber": "EMP-001",
  "disqualifiedServices": [
    "serviceId"
  ]
}