Packages API

Lists packages with their courses. An organization client sees packages owned by its organization; a group client sees only packages linked to its group.

List packages

GET /api/v1/packages

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

curl --request GET \
  --url "https://courses.e-learningcourses.com/api/v1/packages?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	Packages per page, from 1 through 5000.
includeArchived	boolean	false	Set to true to include archived packages.

Response

{
  "data": [
    {
      "packageId": "46647b28-2785-4435-9fa9-715e8c461902",
      "name": "Supplier Compliance",
      "type": "standard",
      "archived": false,
      "courses": [
        {
          "courseId": "38f595b7-2ff4-4da6-bf24-91316399ec9a",
          "name": "Supplier Code of Conduct"
        }
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 1000,
    "totalRecords": 1,
    "totalPages": 1
  }
}

Field	Type	Description
packageId	UUID	Package identifier.
name	string	Package name.
type	string	standard or versioned. A versioned package contains successive versions of a course, so a learner may have training records for more than one of its courses.
archived	boolean	Whether the package is archived.
courses	array	Courses currently linked to the package. May be empty.
courses[].courseId	UUID	Course identifier. Matches courseId in training records and certificates.
courses[].name	string	Course name.

Packages are ordered by name, then packageId. The pagination object counts packages after applying includeArchived; it does not count the courses inside them. An empty result has data: [] and totalPages: 0.

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