Visualizar Grupo

GET

/v1/groups/{groupId}

Visualizar informações do 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 Caminho

groupId*

Identificador do grupo.

Tipostring

Obrigatório

Respostas

Grupo específicado

Content-Type

application/json

{

"_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"

}

}

}

GET

/v1/groups/{groupId}

Exemplos

cURL

JavaScript

PHP

Python