Search docs/

Listar grupos

{...}

Listar grupos existentes no Layers

GET https://api.layers.digital/v1/groups
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 pelo menos uma das seguintes permissões: group:readgroup:read:scoped

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.

Resposta

Especificação

  • [].idString

    identificador do documento do grupo

  • [].createdAtString

    Data de criação do grupo em UTC corrigido para o fuso da comunidade

  • [].updatedAtString

    Data da última modificação do grupo em UTC corrido para o fuso da comunidade

  • [].communityString

    Identificador da communidade do grupo

  • [].nameStringobrigatório

    Nome do grupo

  • [].tagsObject[ ]

    tags às quais esse grupo pertence

  • [].adminsObject[ ]

    administradores do grupo

  • [].activeBoolean

    Chave que indica se o grupo está ativo (quando o grupo é apagado, essa chave é mudada para false)

  • [].syncedAtString

    data da última vez que esse grupo foi modificado pela rota /sync

  • [].seasonString

    temporada à qual esse grupo pertence

Exemplo

[
  {
    "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