Get groups

Get groups with pagination

get/groups

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
  • Auth: OAuth 2 (implicit, authorization URL https://gamelearn.auth.eu-west-1.amazoncognito.com/oauth2/token?grant_type=client_credentials, scopes: groups:read)

Query parameters

limitstring

number of groups

pagestring

number of page

Response

Groups matching pagination options

limitnumber

Number of groups

totalnumber

Total number of groups

pagenumber

Page number

pagesnumber

Total number of pages

Example response

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

Changes

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