Get group

Get group info

get/groups/{groupId}

Request

  • Base URL: https://evr151p8w1.execute-api.eu-west-1.amazonaws.com/integration
  • URL: https://evr151p8w1.execute-api.eu-west-1.amazonaws.com/integration/groups/{groupId}
  • Auth: OAuth 2 (implicit, authorization URL https://gamelearn.auth.eu-west-1.amazoncognito.com/oauth2/token?grant_type=client_credentials, scopes: groups:read)

Path parameters

groupIdstring required

Group id

Response

group detail

idstring

Group id

namestring

Group name

startDatestring

Start date

endDatestring

End date

numberOfLicensesnumber

Number of licenses

tagsstring[]

Group tags

Example response

{
  "id": "507f1f77bcf86cd799439011",
  "name": "Awesome group",
  "startDate": "2020-01-01T00:00:00.000Z",
  "endDate": "2020-12-31T23:59:59.999Z",
  "numberOfLicenses": 10,
  "tags": [
    "tag"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.