Sign in

v1

latestOpenAPI 3.1.02026-08-06911,228852.2 KB
Staff

Get Single User

get/staff/v1/businessLocations/{businessLocationId}/staff/{staffId}

Path parameters

businessLocationIdinteger required

The unique identifier for the business location.

staffIdinteger required

The unique identifier for the user.

Response

User object

staffIdinteger

The unique identifier for the user.

usernamestring

The staff username. Only used for POS staff.

userTypesStaffApiUserType[]
firstNamestring

The first name of the user.

lastNamestring

The last name of the user.

emailstring email

The email associated with the user. Only used for Back Office staff.

activeboolean

Indicates if the user is active.

pinCodeSetboolean

Indicates if the user has a PIN code set. Relevant for POS users only.

pinLengthinteger nullable

Length of the user's PIN code. Null when PIN is not set.

createdOnstring date-time

The timestamp of the creation of the user.

modifiedOnstring date-time

The timestamp of the last update to the user.

businessIdinteger

The unique identifier for the business.

businessLocationIdinteger

The unique identifier for the business location.

reportAccessStaffApiReportAccess[]

Example response

{
  "staffId": 1234,
  "username": "John Doe",
  "firstName": "John",
  "lastName": "Doe",
  "businessId": 12345,
  "businessLocationId": 1234567890,
  "groups": [
    {
      "id": 1234,
      "name": "Bar Staff"
    }
  ],
  "roles": [
    {
      "id": 1234,
      "name": "ROLE_CAN_LOGIN"
    }
  ]
}