Get Single Staff

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

Path parameters

  • businessLocationId integer(int64) Required

    Unique identifier for a business location.

  • staffId integer(int64) Required

    Unique identifier for an employee.

Responses

  • 200 application/json

    Staff object

    Hide response attributes Show response attributes object
    • staffId integer(int64)

      Unique identifier for an employee.

    • username string

      Only used for POS staff

      Maximum length is 128.

    • userTypes array[string]

      Values are POS, BACK_OFFICE, or API.

    • First name of the employee.

      Maximum length is 128.

    • lastName string

      Last name of the employee.

      Maximum length is 128.

    • email string(email)

      Only used for Back Office staff

      Maximum length is 128.

    • active boolean

      Whether the employee is active.

    • createdOn string(date-time)

      Timestamp of the creation of the employee.

    • modifiedOn string(date-time)

      Timestamp of the last update to the employee.

    • businessId integer(int64)

      The unique identifier of the business.

    • businessLocationId integer(int64)

      The unique identifier of the business location.

    • groups array[object]
      Hide groups attributes Show groups attributes object
      • id integer(int64)

        Unique identifier for an employee group.

      • name string

        Name of the employee group.

    • reportAccess array[string]

      Employee report permissions.

    • roles array[object]
      Hide roles attributes Show roles attributes object
      • id integer(int64)

        Unique identifier for a role.

      • name string

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