List staffs

get http://api-gateway-eu.phorest.com/third-party-api-server/api/business/{businessId}/branch/{branchId}/staff

Get a list of staffs for the specified business id and branch id. There is an option to include archived staffs in the list

Responses

Language

Credentials

Basic

base64

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url http://api-gateway-eu.phorest.com/third-party-api-server/api/business/businessId/branch/branchId/staff \
3
     --header 'accept: */*'


xxxxxxxxxx
57
}
1
{
2
  "links": [
3
    {
4
      "rel": "string",
5
      "href": "string",
6
      "hreflang": "string",
7
      "media": "string",
8
      "title": "string",
9
      "type": "string",
10
      "deprecation": "string",
11
      "profile": "string",
12
      "name": "string"
13
    }
14
  ],
15
  "_embedded": [
16
    {
17
      "staffId": "staff123",
18
      "staffCategoryId": "l7fizkAS1JA8TzMoO4iliA",
19
      "userId": "TyfizkAS1JA8TzMoO4iliA",
20
      "staffCategoryName": "Administrator",
21
      "firstName": "John",
22
      "lastName": "Doe",
23
      "birthDate": "2025-04-02",
24
      "startDate": "2025-04-02",
25
      "selfEmployed": false,

200Staffs listed

400Bad Request

404Business or branch with the specified ids don't exist

429Request rate limit exceeded. Current limit set to 100 rps.

500Internal Server Error