Developer Center
Pesquisar K

Appearance

Buscar usuários​

GET
/v1/users/search

Buscar contas de acesso de usuários. Essa busca pode ser feita com filtros através dos parâmetros listados bem como texto livre no parâmetro q.

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
roles

Permissão que o usuário possui

Tipostring
q

Texto de busca. Pode ser o nome, e-mail ou alias do usuário.

Tipostring
emails

Lista de emails para busca.

Tipoarray

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