List team members

Returns one page of the back-office staff directory: the accounts that can sign into the POS, each with its identity, contact email, primary role label (owner, manager, cashier, viewer, …), the store (or whole network) it is scoped to, and whether it is still active. Reach for this to FIND somebody when you only know their role or store, to answer ‘who works at X’, or to discover a member id before a write; when you already hold the id, call getTeamMember instead. Narrow with role (an EXACT label match, not a search — manager matches, Manager and manag do not) and active (the strings true / false). Order with sortField (name / role) plus sortDirection (asc default); sortDirection alone is IGNORED — the route only builds a sort when sortField is present. Walk the directory with page / pageSize (max 100) until page reaches pageCount. This returns the flat directory PROJECTION, never the underlying RBAC grants: role is a display label, so do not infer from it what the account may actually do — call whoami as that actor for that, or read the operation’s own x-required-permissions.

GET /v1/team

Error

A valid request URL is required to generate request examples

200

{
  "items": [
    {
      "id": "user-julie",
      "name": "Julie Ferrand",
      "email": "[e-mail]",
      "role": "manager",
      "store": "Magasin Bastille",
      "active": true
    }
  ],
  "total": 15,
  "page": 1,
  "pageSize": 20,
  "pageCount": 1
}

Authorizations

Authorization · string · header · required

Authorization: Bearer <token>. Accepts EITHER a Keycloak access token (scopes-in-token) OR an opaque POS session token; both resolve to the same pos.* scope vocabulary the route guards enforce.

Query Parameters

page · integer

1-based page number (default 1).

Required range: 0 < x <= 9007199254740991

pageSize · integer

Rows per page, 1-100 (default 20).

Required range: 0 < x <= 100

role · string

EXACT primary-role label to filter on (e.g. manager) — not a search.

Minimum string length: 1

active · enum<string>

Filter by sign-in state: true (active) or false (offboarded).

Available options: true, false

sortField · enum<string>

Field to order by: name or role.

Available options: name, role

sortDirection · enum<string>

Order direction for sortField (default asc); ignored without sortField.

Available options: asc, desc

Response

200

application/json

A page of team-directory rows with the pagination totals.

A page of team-directory rows with the pagination totals.

items · object[] · required

Show child attributes

total · integer · required

Required range: -9007199254740991 <= x <= 9007199254740991

page · integer · required

Required range: -9007199254740991 <= x <= 9007199254740991

pageSize · integer · required

Required range: -9007199254740991 <= x <= 9007199254740991

pageCount · integer · required

Required range: -9007199254740991 <= x <= 9007199254740991