Developer Center
Pesquisar K

Appearance

Buscar grupos​

GET
/v1/groups/search

Buscar grupos usando texto livre no parametro q e outros parâmetros de filtro.

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
active

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

Tipoboolean
name

Nome

Tipostring
admins.user

Id de um dos administradores do grupo

Tipostring
season

Temporada do documento. Geralmente é o ano letivo.

Tipostring
alias

Identificador na Layers Education

Tipostring
q

Texto de busca. Pode ser o nome ou identificador do grupos.

Tipostring

Respostas​

Número e lista de grupos encontrados

application/json
JSON
{
"total": 0,
"hits": [
{
"_id": "string",
"alias": "3A",
"createdAt": "2020-01-01T00:00:00.000Z",
"updatedAt": "2020-01-01T00:00:00.000Z",
"community": "test",
"name": "Terceiro ano A",
"tags": [
{
"id": "string",
"name": "Ensino Fundamental"
}
],
"admins": [
{
"user": "string"
}
],
"active": true,
"syncedAt": "2020-03-01T00:00:00.000Z",
"season": "Ano letivo 2020",
"fields": {
"@education:basic": {
"tipo": {
"_id": "string",
"label": "string"
},
"nivel": {
"_id": "string",
"label": "string"
},
"periodo": "string"
}
}
}
]
}

Exemplos​

cURL
JavaScript
PHP
Python