Developer Center
Pesquisar K

Appearance

Listar usuários​

GET
/v1/users

Listar contas de acesso de usuários.

Autorizações​

Bearer

Generate a token

TipoHTTP (bearer)

Parâmetros​

Parâmetros de Cabeçalho

community-id*

Identificador da comunidade

Tipostring
Obrigatório
Exemplo"test"

Parâmetros de Consulta

createdAt

Data de criação do documento

Tipostring
updateAt

Data da última modificação do documento

Tipostring
status

Indicador do status do usuário. Pode ser ativo (ACTIVE), convidado (INVITED) ou não convidado (INACTIVE)

Tipostring
active

Indicador do estado do documento. Quando verdadeiro o documento está ativo e quando falso o documento está apagado.

Tipoboolean
roles

Permissão que o usuário possui

Tipostring

Respostas​

OK

application/json
JSON
{
"total": 10,
"hits": [
{
"_id": "string",
"createdAt": "2020-01-01T00:00:00.000Z",
"updatedAt": "2020-01-01T00:00:00.000Z",
"active": true,
"community": "test",
"status": "ACTIVE",
"invitationCount": 2,
"email": "luke@starwars.com",
"name": "Gabriel Raniere",
"roles": [
[
"guardian",
"professor"
]
],
"address": {
"code": "01414-001",
"state": "SP",
"city": "São Caetano do Sul",
"district": "Centro",
"address": "Rua Pará",
"number": "79"
}
}
]
}

Exemplos​

cURL
JavaScript
PHP
Python