← Documentation home
GET/hyax-api/v1/courses

List courses

Lists COURSE-type products with module/unit counts.

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

Query parameters

NameRequiredDescription
pageNoPage number (default 1)
limitNoPage size (default 20, max 100)
searchNoSearch title or slug
slugNoExact slug match
isActiveNo`true` | `false` — published vs unpublished
archivedNo`true` — list archived courses only

Request examples

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

curl -X GET 'https://platform.hyax.com/hyax-api/v1/courses?page=1&limit=10' \
  -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",
      "pricingType": "SINGLE",
      "price": 99,
      "isActive": true,
      "moduleCount": 3,
      "unitCount": 12
    }
  ],
  "pagination": { "page": 1, "limit": 20, "total": 5, "totalPages": 1 }
}