Developer Center
Pesquisar K

Appearance

Buscar membros​

GET
/v1/members/search

Buscar membros. 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
active

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

Tipoboolean
alias

Identificador na Layers Education

Tipostring
q

Texto de busca. Pode ser o nome ou alias do membro.

Tipostring

Respostas​

Número e lista de membros encontrados.

application/json
JSON
{
"total": 1,
"hits": [
{
"_id": "12345678",
"createdAt": "2020-01-01T00:00:00.000Z",
"updatedAt": "2020-01-01T00:00:00.000Z",
"active": true,
"community": "test",
"access": [
{
"permissions": [
"guardian"
],
"user": "string"
}
],
"name": "Gabriel Raniere",
"alias": "abc123d",
"birth": "2010-04-10T00:00:00.000Z"
}
]
}

Exemplos​

cURL
JavaScript
PHP
Python