Staff
List staffs
Get a list of staffs for the specified business id and branch id. There is an option to include archived staffs in the list
get/api/business/{businessId}/branch/{branchId}/staff
Path parameters
businessIdstring required
branchIdstring required
Query parameters
updatedAfterstring
updatedAfter date to filter staff updated after a set date. yyyy-MM-dd'T'HH:mm:ss.SSZ
updatedBeforestring
updatedBefore date to filter staff updated before a set date. yyyy-MM-dd'T'HH:mm:ss.SSZ
fetch_archivedboolean
include archived staffs in the list
number of staff records to return, max is 100
page number, default is 0 and is optional
Response
Staffs listed
Example response
{
"_embedded": {
"staffs": [
{
"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"
]
}
]
}
}