Skip to main content
GET
Listar usuários

Autorizações

Authorization
string
header
obrigatório

Token da API no formato sk_live_….

Parâmetros de consulta

page
integer
padrão:1

Número da página, começando em 1. Um valor inválido é tratado como 1.

Intervalo obrigatório: x >= 1
perPage
integer
padrão:20

Quantidade de itens por página. O máximo depende do ambiente (padrão 100).

Intervalo obrigatório: 1 <= x <= 100

Busca por nome ou e-mail.

profileId
integer

Filtra pelo perfil de permissões. Use o id de GET /profiles.

filterStatus
enum<string>

Filtra pela situação do usuário. pending indica convite ainda não aceito.

Opções disponíveis:
active,
inactive,
pending
filterOnline
enum<string>

Filtra os usuários pela presença. Use online para quem está conectado agora ou offline para quem está desconectado.

Opções disponíveis:
online,
offline

Resposta

200 - application/json

OK

data
object[]
meta
object
Exemplo: