GET/hyax-api/v1/navigation

Get navigation links

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

Query parameters

Name	Required	Description
linkPlacement	No	`HEADER` (default) or `FOOTER`

Request examples

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

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

Example response

Shape varies by data; values are illustrative.

{
  "success": true,
  "linkPlacement": "HEADER",
  "data": [
    {
      "id": "clx…",
      "label": "Blog",
      "url": "/blog",
      "navigationType": "URL",
      "order": 0,
      "children": []
    }
  ]
}