Antylogic
DemoApp login

399 operational guides

Docs sections
DocsTeam
Device

How to list employee roles

Open the Employee roles tab for the selected location, review role names, descriptions and active staff assignments, and filter the loaded list by name or description.

In this article

Employee roles are managed inside the staff area for a specific location. The list never mixes roles from another location, so Harbor Soho only shows the roles attached to Harbor Soho.

The table is a read-only listing surface for this action. It helps operators check which roles exist, whether active employees are assigned, and how a search narrows the visible roles without changing data.

Before you start

  • The operator is signed in with an active organisation and location selected.
  • The operator is working inside a location; staff roles are scoped to `location_id`, not to the whole organisation.
  • The operator has `staff-roles:view` for the location. To see active assignments in the Employees column, the operator also needs `staff:view` or `staff:manage`.

Instructions

  1. 1.

    Open Employee roles

    Open staff management for the active location and select Employee roles. If the route already contains `location/staff?tab=roles`, the app opens that tab when the operator has access.

  2. 2.

    Review the table

    Use the table to check Name, Description and Employees. Role names appear as coloured badges, and the Employees column is calculated from active staff records when staff visibility is available.

  3. 3.

    Search roles

    Type in the search field to filter the already loaded roles by name or description. The search is case-insensitive and does not call a server-side search endpoint.

  4. 4.

    Page and refresh

    Use pagination when the role list spans more than one page. Refresh reloads the staff roles list and, when allowed, the supporting staff data used for employee assignment avatars.

  5. 5.

    Read row actions as permissions

    Operators with view access can open a role in view mode. Operators with management access may see Edit and Delete controls, but create, update and delete belong to separate staff role actions.

Validations and limits

  • If no organisation or location is selected, the screen shows the location-not-found state.
  • If the operator cannot access either Employees or Employee roles, the screen shows the no-access state.
  • `GET /api/app/{orgId}/{locationId}/staff-roles` requires `staff-roles:view` and only returns roles whose `location_id` matches the active location.
  • Roles are returned ordered by `name ASC`; search and pagination are then applied in the client.
  • `roles_query`, `roles_page` and `roles_page_size` are UI route parameters. The staff roles endpoint does not implement server-side search, pagination or sorting controls.
  • Invalid, zero or negative `roles_page` values resolve to page 1, and out-of-range pages are corrected to a valid page.
  • The Employees column is derived from active `staff` grouped by `staff_role_id`; archived staff do not count, and `GET /staff-roles` does not return employee counts.
  • If a custom permission setup grants `staff-roles:manage` without `staff-roles:view`, the tab may be visible while the list request is still rejected by the backend.

Expected result

The operator can review and filter the selected location's employee roles, with active staff assignments shown when staff read access is available, without creating, editing or deleting role records.

Related articles