---
title: "Get Single User Group"
method: GET
path: "/staff/v1/businessLocations/{businessLocationId}/groups/{groupId}"
tags: ["Staff"]
---

# Get Single User Group

`GET /staff/v1/businessLocations/{businessLocationId}/groups/{groupId}`

## Request

- Base URL: `https://api.trial.lsk.lightspeed.app`
- URL: `https://api.trial.lsk.lightspeed.app/staff/v1/businessLocations/{businessLocationId}/groups/{groupId}`
- Auth: OAuth 2
  - Authorization code: `https://auth.lsk-prod.app/realms/k-series/protocol/openid-connect/auth`
  - Token URL: `https://auth.lsk-prod.app/realms/k-series/protocol/openid-connect/token` scopes: `staff-api`

## Path parameters

- `businessLocationId` integer, required
- `groupId` integer, required

## Response `200`

POS User Group

- object
  - `data` object
    - `staffGroup` StaffApiStaffGroup
      - `id` integer: The unique identifier for the user group.
      - `name` string: The name of the user group.
      - `posAccessForbidden` boolean: Whether POS users in this group are restricted from POS access (for e.g. time-clock access only).
      - `roles` StaffApiStaffRoleDto[]
        - `id` integer: The unique identifier for the role.
        - `name` string: The name of the role.
      - `reportAccess` string: User report permissions.
  - `links` object
    - `first` object
      - `href` string, uri: The URL for the first page of results.
    - `self` object
      - `href` string, uri: The URL for the current page of results.
    - `next` object
      - `href` string, uri: The URL for the next page of results.
    - `last` object
      - `href` string, uri: The URL for the last page of results.
  - `page` StaffApiPageInfo
    - `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.

## Changes

> 31 revisions in range; 1 not diffed.

- **2026-08-06** `fd2e31cf57dd`: 1 info
  - added the optional property `allOf[subschema #2]/data/staffGroup/posAccessForbidden` to the response with the `200` status
- **2025-01-21** `707b55d222ab`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/lightspeed/apis/lightspeed-restaurant-k-series-api/changes/staff/v1/businessLocations/:businessLocationId/groups/:groupId/get.md)

---

[API](https://skmtc.dev/lightspeed/apis/lightspeed-restaurant-k-series-api.md) - [All operations](https://skmtc.dev/lightspeed/apis/lightspeed-restaurant-k-series-api/llms.txt) - [OpenAPI document](https://skmtc.dev/lightspeed/apis/lightspeed-restaurant-k-series-api/revisions/af001485cf2b?raw)