Get Single User

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

Path parameters

businessLocationId integer(int64) Required

The unique identifier for the business location.
staffId integer(int64) Required

The unique identifier for the user.

Responses

200 application/json

User object
Hide response attributes Show response attributes object
- staffId integer(int64)
  
  The unique identifier for the user.
- username string
  
  The staff username. Only used for POS staff.
  
  Maximum length is 128.
- userTypes array[string]
  
  The user type.
  
  Values are POS, BACK_OFFICE, or API.
- firstName string
  
  The first name of the user.
  
  Maximum length is 128. Default value is empty.
- lastName string
  
  The last name of the user.
  
  Maximum length is 128. Default value is empty.
- email string(email)
  
  The email associated with the user. Only used for Back Office staff.
  
  Maximum length is 128.
- active boolean
  
  Indicates if the user is active.
  
  Default value is true.
- createdOn string(date-time)
  
  The timestamp of the creation of the user.
- modifiedOn string(date-time)
  
  The timestamp of the last update to the user.
- businessId integer(int64)
  
  The unique identifier for the business.
- businessLocationId integer(int64)
  
  The unique identifier for the business location.
- groups array[object]
  
  Hide groups attributes Show groups attributes object
  
  id integer(int64)
  
  The unique identifier for the user group.
  
  name string
  
  The name of the user group.
- reportAccess array[string]
  
  User report permissions.
  
  Default value is STAFF_REPORT_OWN_ACCESS.
- roles array[object]
  
  The roles assigned to the user.
  
  Hide roles attributes Show roles attributes object
  
  id integer(int64)
  
  The unique identifier for the role.
  
  name string
  
  The name of the role.

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

curl \
 -X GET https://api.lsk.lightspeed.app/staff/v1/businessLocations/{businessLocationId}/staff/{staffId} \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "staffId": 1234,
  "username": "John Doe",
  "userTypes": [
    "POS"
  ],
  "firstName": "John",
  "lastName": "Doe",
  "email": "hello@example.com",
  "active": true,
  "createdOn": "2024-05-04T09:42:00+00:00",
  "modifiedOn": "2024-05-04T09:42:00+00:00",
  "businessId": 12345,
  "businessLocationId": 1234567890,
  "groups": [
    {
      "id": 1234,
      "name": "Bar Staff"
    }
  ],
  "reportAccess": [
    "STAFF_REPORT_OWN_ACCESS"
  ],
  "roles": [
    {
      "id": 1234,
      "name": "ROLE_CAN_LOGIN"
    }
  ]
}