Get All User Groups

GET /staff/v1/businessLocations/{businessLocationId}/groups
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 ["name,asc"].

  • name string

    Filter on group name.

  • roles array[string]

    Filter on group roles.

Responses

  • 200 application/json

    POS User Groups List

    Hide response attributes Show response attributes object
    • data object

      Additional properties are allowed.

      Hide data attribute Show data attribute object
      • staffGroupList array[object]
        Hide staffGroupList attributes Show staffGroupList attributes object
        • id integer(int64)

          The unique identifier for the user group.

        • name string

          The name of the user group.

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

            The unique identifier for the role.

          • name string

            The name of the role.

        • reportAccess string

          User report permissions.

          Default value is STAFF_REPORT_OWN_ACCESS.

    • 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}/groups 
curl \
 -X GET https://api.trial.lsk.lightspeed.app/staff/v1/businessLocations/{businessLocationId}/groups \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "data": {
    "staffGroupList": [
      {
        "id": 1234,
        "name": "Bar Staff",
        "roles": [
          {
            "id": 1234,
            "name": "ROLE_CAN_LOGIN"
          }
        ],
        "reportAccess": "STAFF_REPORT_OWN_ACCESS"
      }
    ]
  },
  "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
  }
}