GET/hyax-api/v1/posts

List posts

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

Query parameters

Name	Required	Description
page	No	Default 1
limit	No	Default 20, max 100
status	No	`DRAFT` \| `SCHEDULED` \| `PUBLISHED` \| `ARCHIVED`
postType	No	`REGULAR` (default) \| `COURSE_UNIT` \| `PAGE`

Request examples

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

curl -X GET 'https://platform.hyax.com/hyax-api/v1/posts?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": "Hello world",
      "description": null,
      "slug": "hello-world",
      "status": "PUBLISHED",
      "image": null,
      "tags": [],
      "postType": "REGULAR",
      "publishedAt": "2025-01-15T12:00:00.000Z",
      "createdAt": "2025-01-15T12:00:00.000Z",
      "updatedAt": "2025-01-15T12:00:00.000Z",
      "authorId": "usr…",
      "author": { "id": "usr…", "name": "Jane", "email": "[email protected]" }
    }
  ],
  "pagination": { "page": 1, "limit": 20, "total": 1, "totalPages": 1 }
}