Get All POS Staff

GET /staff/v1/businessLocations/{businessLocationId}/userTypes/POS

Path parameters

Query parameters

  • page integer(int32)

    The page number, when paginating.

    Minimum value is 1. Default value is 1.

  • size integer(int32)

    Number of results to return per page, when paginating.

    Minimum value is 1. Default value is 10.

  • sort array[string]

    Sort by field and direction.

    Default value is ["userId,desc"].

  • isActive boolean

    Filter on active status.

  • startDate string(date-time)

    Filter on employee start date.

  • endDate string(date-time)

    Filter on employee end date.

Responses

  • 200 application/json

    Staff List

    Hide response attributes Show response attributes object
    • data object
      Hide data attribute Show data attribute
      • staff array[object]
        Hide staff attributes Show staff attributes object
        • staffId integer(int64)

          Unique identifier for an employee.

        • username string

          The staff username. Only used for POS users.

          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.

        • 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.

    • page object
      Hide page attributes Show page attributes
GET /staff/v1/businessLocations/{businessLocationId}/userTypes/POS
curl \
 -X GET https://api.lsk.lightspeed.app/staff/v1/businessLocations/{businessLocationId}/userTypes/POS \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "data": {
    "staff": [
      {
        "staffId": 1234,
        "username": "John Doe",
        "userTypes": [
          "POS"
        ],
        "firstName": "John",
        "lastName": "Doe",
        "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"
          }
        ]
      }
    ]
  },
  "links": {
    "first": {
      "href": "https://api-trial.ikentoo.com/staff/v1/businessLocations/40570261078018/userTypes/POS?page=1&size=1&sort=userId,desc"
    },
    "self": {
      "href": "https://api-trial.ikentoo.com/staff/v1/businessLocations/40570261078018/userTypes/POS?page=1&size=1&sort=userId,desc"
    },
    "next": {
      "href": "https://api-trial.ikentoo.com/staff/v1/businessLocations/40570261078018/userTypes/POS?page=2&size=1&sort=userId,desc"
    },
    "last": {
      "href": "https://api-trial.ikentoo.com/staff/v1/businessLocations/40570261078018/userTypes/POS?page=5&size=1&sort=userId,desc"
    }
  },
  "page": {
    "page": 1,
    "size": 10,
    "totalElements": 100,
    "totalPages": 10
  }
}