Skip to main content

Users

2026-09-04 — Users — list your company staff​

🆕 New

  • GET /v1/users — Paginated list of the users of your company (staff such as admins, managers, waiters, riders, cooks, sales and cashiers).

Scopes​

  • users:read — required by the endpoint. Existing API keys need it granted before calling it.

Notes

  • Filter by role with filter[role], one role or several separated by commas (filter[role]=waiter,rider). Allowed roles: admin, manager, waiter, rider, cook, sales, cashier.
  • Filter by account status with filter[active]=true|false. Without it the list includes deactivated users; check the active field on each item.
  • Page through results with page and per_page (default 20, max 100). The pagination object tells you whether there are more pages.
  • Each user carries a single role.