Search docs/

Buscar matriculas

{...}

Buscar matrículas no grupo especificado

GET https://api.layers.digital/v1/enrollments/search
CopiarCopiado

Autenticação

Autenticação do tipo Token Bearer é necessária para acessar essa rota.

Parâmetros

  • community-id
    (header)
    obrigatório
    Identificador da comunidade
  • active
    (query)
    Indicador do estado do documento. Quando verdadeiro o documento está ativo e quando falso o documento está apagado.
  • group
    (query)
    Identificador do grupo

Resposta

Especificação

Exemplo

{
  "total": 1,
  "hits": [
    {
      "id": "5bb2575199d7179dfe85be02",
      "createdAt": "2020-01-01T00:00:00.000Z",
      "updatedAt": "2020-01-01T00:00:00.000Z",
      "community": "test",
      "kind": "member",
      "entity": "5bb2575199d7179dfe85be02",
      "group": "5bb2575199d7179dfe85be02",
      "active": true
    }
  ]
}
CopiarCopiado