GET/hyax-api/v1/courses/:id

Get course

Full course with modules, units, and linked post/quiz metadata.

Base URL: https://platform.hyax.com · Replace YOUR_API_KEY with your team API key.

Query parameters

Name	Required	Description
slug	No	Lookup by slug instead of path id

Request examples

Same request in cURL, Node.js (fetch), and PHP (ext-curl).

curl -X GET 'https://platform.hyax.com/hyax-api/v1/courses/clx_example_id' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Example response

Shape varies by data; values are illustrative.

{
  "success": true,
  "data": {
    "id": "clx…",
    "title": "Intro to Marketing",
    "slug": "intro-to-marketing",
    "isActive": true,
    "moduleCount": 1,
    "unitCount": 2,
    "modules": [
      {
        "id": "mod…",
        "title": "Module 1",
        "unitCount": 2,
        "units": [{ "id": "unit…", "title": "Lesson 1", "unitType": "CONTENT" }]
      }
    ]
  }
}