Pular para o conteúdo principal

Usuários

2026-09-04 — Usuários — listar a equipe da sua empresa​

🆕 Novo

  • GET /v1/users — Lista paginada dos usuários da sua empresa (equipe como admins, gerentes, garçons, entregadores, cozinheiros, vendedores e caixas).

Escopos​

  • users:read — obrigatório para o endpoint. As API keys existentes precisam desse escopo concedido antes de chamá-lo.

Notas

  • Filtre por função com filter[role], uma ou várias separadas por vírgulas (filter[role]=waiter,rider). Funções permitidas: admin, manager, waiter, rider, cook, sales, cashier.
  • Filtre por status da conta com filter[active]=true|false. Sem esse filtro a lista inclui usuários desativados; verifique o campo active em cada item.
  • Pagine os resultados com page e per_page (padrão 20, máximo 100). O objeto pagination indica se há mais páginas.
  • Cada usuário carrega uma única role.