← Documentation home
GET/hyax-api/v1/posts/:id

Get post

Returns full post including `content`, `categoryIds`, and `mediaAttachments`.

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

Request examples

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

curl -X GET 'https://platform.hyax.com/hyax-api/v1/posts/clx_example_id' \
  -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,
    "content": "<p>Post body</p>",
    "slug": "hello-world",
    "status": "PUBLISHED",
    "image": null,
    "tags": [],
    "postType": "REGULAR",
    "pricingType": "FREE",
    "price": null,
    "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]" },
    "categoryIds": [],
    "mediaAttachments": [
      { "id": "clx…", "type": "IMAGE", "isFeatured": true, "url": "https://…" }
    ]
  }
}