Groups API

Lists the customer groups available to the API client. An organization client sees its organization's groups; a group client sees only its own group.

List groups

GET /api/v1/groups

Required scope: training.read. See Authentication to obtain an access token.

curl --request GET \
  --url "https://courses.e-learningcourses.com/api/v1/groups?page=1&pageSize=1000&includeArchived=false" \
  --header "Authorization: Bearer $ACCESS_TOKEN" \
  --header "Accept: application/json"

Query parameters

Parameter	Type	Default	Description
page	integer	1	Page number, starting at 1.
pageSize	integer	1000	Groups per page, from 1 through 5000.
includeArchived	boolean	false	Set to true to include archived groups.

Response

{
  "data": [
    {
      "groupId": "fbc74870-3995-4f2c-b129-c2812b3e56c7",
      "name": "Example Supplier",
      "supplierNo": "SUP-1042",
      "archived": false
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 1000,
    "totalRecords": 1,
    "totalPages": 1
  }
}

Field	Type	Description
groupId	UUID	Group identifier. Matches groupId in training records and certificates.
name	string	Group name.
supplierNo	string or null	Supplier number assigned to the group, when available.
archived	boolean	Whether the group is archived.

Groups are ordered by name, then groupId. The pagination object counts groups after applying includeArchived. An empty result has data: [] and totalPages: 0.

When resolving a groupId from older training data, use includeArchived=true if the group may have been archived.

Errors

Invalid paging returns 400 in Problem Details format. A missing or expired token returns 401; insufficient scope or a client that has lost access returns 403. The shared API limit can return 429. See Authentication for rate limits and retry guidance.

OpenAPI

https://courses.e-learningcourses.com/api/v1/openapi.json