Get All POS Users

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

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 user start date. The format should be yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format).

  • endDate string(date-time)

    Filter on user end date. The format should be yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format).

Responses

  • 200 application/json

    Staff List

    Hide response attributes Show response attributes object
    • data object

      Additional properties are allowed.

      Hide data attribute Show data attribute object
      • staff array[object]
        Hide staff attributes Show staff 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.

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

    • links object

      Additional properties are allowed.

      Hide links attributes Show links attributes object
      • first object

        Additional properties are allowed.

        Hide first attribute Show first attribute object
        • href string(uri)

          The URL for the first page of results.

      • self object

        Additional properties are allowed.

        Hide self attribute Show self attribute object
        • href string(uri)

          The URL for the current page of results.

      • next object

        Additional properties are allowed.

        Hide next attribute Show next attribute object
        • href string(uri)

          The URL for the next page of results.

      • last object

        Additional properties are allowed.

        Hide last attribute Show last attribute object
        • href string(uri)

          The URL for the last page of results.

    • page object

      Additional properties are allowed.

      Hide page attributes Show page attributes object
      • page integer

        The current page number.

      • size integer

        The number of elements in the page.

      • totalElements integer

        The total number of elements.

      • totalPages integer

        The total number of pages of results.
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
  }
}