Search docs/

Buscar grupos

{...}

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

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

Autenticação

Autenticação do tipo Token Bearer é necessária para acessar essa rota. O app deve estar cadastrado para usar a API com a permissão group:read

Parâmetros

  • community-id
    (header)
    obrigatório
    Identificador da comunidade
  • createdAt
    (query)
    Data de criação do documento
  • active
    (query)
    Indicador do estado do documento. Quando verdadeiro o documento está ativo e quando falso o documento está apagado.
  • name
    (query)
    Nome
  • admins.user
    (query)
    Id de um dos administradores do grupo
  • season
    (query)
    Temporada do documento. Geralmente é o ano letivo.
  • q
    (query)
    Texto de busca. Pode ser o nome ou identificador do grupos.

Resposta

Especificação

  • totalNumber

    Número de resultados encontrados

  • hitsGroup[ ]

    Array contendo os resultados da busca ordenados pelos que mais se encaixam nos termos da busca

Exemplo

{
  "total": 5.5,
  "hits": [
    {
      "id": "5bb2575199d7179dfe85be02",
      "createdAt": "2020-01-01T00:00:00.000Z",
      "updatedAt": "2020-01-01T00:00:00.000Z",
      "community": "test",
      "name": "Terceiro ano A",
      "tags": [
        {
          "id": "exemplo",
          "name": "Ensino Fundamental"
        }
      ],
      "admins": [
        {
          "user": "exemplo"
        }
      ],
      "active": true,
      "syncedAt": "2020-03-01T00:00:00.000Z",
      "season": "Ano letivo 2020"
    }
  ]
}
CopiarCopiado