v1

latestOpenAPI 3.0.1Apache 2.02026-07-2473111182.6 KB
Staff

Retrieve a batch of staffs

Get a batch of staff members for the specified staff ids

get/api/business/{businessId}/branch/{branchId}/staff-batch

Path parameters

businessIdstring required
branchIdstring required

Query parameters

staff_idstring[] required

list of staff ids

Response

Batch of staffs retrieved

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"
        ]
      }
    ]
  }
}