Pular para o conteúdo principal
GET
Listar diretório de usuários

Autorizações

Authorization
string
header
obrigatório

Token JWT de autenticação

Cabeçalhos

x-company-id
string

Identificador da empresa-alvo. Obrigatório apenas para API Keys globais (type=global). Ignorado para API Keys de empresa e usuários humanos.

Parâmetros de consulta

page
integer
padrão:1

Número da página (começa em 1)

Intervalo obrigatório: 0 < x <= 9007199254740991
rowsPerPage
integer
padrão:10

Quantidade de itens por página

Intervalo obrigatório: 0 < x <= 100

Filtra por nome ou e-mail (sem diferenciar maiúsculas).

Maximum string length: 100
status
enum<string>
padrão:ACTIVE

Status dos usuários listados. Padrão: ACTIVE.

Opções disponíveis:
ACTIVE,
INACTIVE

Resposta

Página do diretório de usuários

result
object[]
obrigatório

Usuários da página

meta
object
obrigatório

Metadados da paginação