Academy

Get all academy chapters with their modules

Changed on

Retrieve all chapters with nested modules, ordered by position. Requires the academy add-on to be active for the organization.

get/academy/chapters

Request

  • The document declares no server URL.
  • Auth: none declared

Response

idstring uuid required

The unique identifier of the chapter

titlestring required

The title of the chapter

descriptionstring required

A description of what the chapter covers

positioninteger required

The position of the chapter (0-based)

createdAtstring date-time required

The date the chapter was created

updatedAtstring date-time required

The date the chapter was last updated

Example response

[
  {
    "title": "Getting Started",
    "description": "Learn the basics of working with Ayunis Core.",
    "courseModules": [
      {
        "title": "Creating your first chat",
        "description": "A short walkthrough of the chat interface.",
        "loomUrl": "https://www.loom.com/share/abc123def456"
      }
    ]
  }
]

Changes

  • bb21d62e7eb4Revision changes
    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status