Staff

List staff

The location's staff members, sorted by name. Use a staff id to say who did something, for example who took stock out. PINs are never returned; hasPin says whether a person has one.

get/v1/locations/{locationId}/staff

Request

  • Base URL: https://api.cliento.com
  • URL: https://api.cliento.com/v1/locations/{locationId}/staff
  • Auth: HTTP bearer

Path parameters

locationIdstring required

Response

OK

pinsInUseboolean required

Whether the location has switched PINs on at its point of sale. When false, staff pick their name from a list there, and a PIN a person happens to have is not asked for.

Example response

{
  "data": [
    {
      "hasPin": true,
      "id": "stf_7Qm2xLd9Kc4Vb1Ts8HpWzE",
      "name": "Clara Nyberg",
      "resourceIds": [
        "res_4Hn7pQw2Zt9Lk3Vd6XyRbA"
      ]
    }
  ],
  "pinsInUse": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.