Api
Menus
API reference for menu endpoints.
Menus API
Menus provide navigation structures with nested items and multiple link types.
Get Menu
Fetch a navigation menu by slug.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
slug | string | Yes | Menu slug (e.g., main, footer) |
Example
Response:
Menu Item Types
| Type | Description | URL Format |
|---|---|---|
PAGE | Links to a CMS page | /p/{slug} or full URL with domain |
BLOG | Links to a blog post | /blog/{slug} or full URL with domain |
URL | External or custom URL | As specified |
ANCHOR | In-page anchor link | #{anchor} |
Nested Structure
Menu items support unlimited nesting via the children array. This allows for dropdown menus and mega menus:
Common Menu Slugs
| Slug | Typical Usage |
|---|---|
main | Primary header navigation |
footer | Footer links |
mobile | Mobile-specific navigation |
legal | Legal/policy links |
Caching Menus
Menus rarely change, so aggressive caching is recommended:
Icons
Menu items can include icon identifiers. The icon field contains a string that you can map to your icon library: