Skip to content

Buscar matriculas

GET
/v1/enrollments/search

Buscar matrículas no grupo especificado

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

active

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

Tipoboolean
group

Identificador do grupo

Tipostring

Respostas

Matrículas que correspondem ao filtro da query

application/json
JSON
{
"total": 1,
"hits": [
{
"_id": "string",
"createdAt": "2020-01-01T00:00:00.000Z",
"updatedAt": "2020-01-01T00:00:00.000Z",
"community": "test",
"kind": "member",
"entity": "string",
"group": "string",
"active": true
}
]
}

Exemplos

cURL
JavaScript
PHP
Python