Skip to content

Menus

Menus in the management API. 4 endpoints.

Read the guideOpenAPI 3.1 document

Try it settings

https://api.bifrostorbit.com/cms/manage/v1

The management API takes a management token, which is secret and acts as a person, so nothing here is sent from the docs.

Try it sends each request straight from your browser to the API. The key stays in this page's memory: it is never saved, never sent to docs.bifrostorbit.com and gone when you leave or reload the page. Only reads are run; anything that changes data is described and never sent.

The environment's menus

GET/organisations/{organisationId}/spaces/{spaceId}/navigationKey required

The environment's menus. environmentId is required. Permission: navigation:read.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • environmentIdstringquery, required

    The environment's id. Required.

Responses

  • 200OKList of menus.
    • dataMenu[]

      Fields of data
      • _idstring

        An id.

      • organisationIdstring

        An id.

      • spaceIdstring

        An id.

      • environmentIdstring

        An id.

      • regionIdstring or null

        An id.

      • localeIdstring or null

        An id.

      • keystring

        Such as main.

      • namestring

      • kindstring

        One of header, footer, mobile, custom.
      • itemsMenuItem[]

        Fields of MenuItem

      • createdBystring

        An id.

      • updatedBystring

        An id.

      • createdAtstring

      • updatedAtstring

  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 403ForbiddenLacks navigation:read.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 404Not foundNo such space, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 500Server errorSomething went wrong on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

Shell
curl 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/navigation?environmentId=6650f1c2a9e4b1d2c3f40a13' \  -H 'Authorization: Bearer cms_mt_…'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

Example answer

200 OKJSON
{  "data": [    {      "_id": "6650f1c2a9e4b1d2c3f40a44",      "organisationId": "6650f1c2a9e4b1d2c3f40a01",      "spaceId": "6650f1c2a9e4b1d2c3f40a02",      "environmentId": "6650f1c2a9e4b1d2c3f40a13",      "regionId": "6650f1c2a9e4b1d2c3f40a17",      "localeId": "6650f1c2a9e4b1d2c3f40a18",      "key": "main",      "name": "Main menu",      "kind": "header",      "items": [        {          "id": "6650f1c2a9e4b1d2c3f40a48",          "label": "Trips",          "kind": "folder",          "contentId": "6650f1c2a9e4b1d2c3f40a21",          "folderId": "6650f1c2a9e4b1d2c3f40a20",          "href": null,          "target": "_self",          "icon": null,          "badge": null,          "description": "Six days of paddling between the peaks of Lofoten.",          "visible": true,          "travel": {            "id": "6650f1c2a9e4b1d2c3f40a40",            "name": "Lofoten sea kayaking",            "kind": "country"          },          "children": []        }      ],      "createdBy": "6650f1c2a9e4b1d2c3f40a30",      "updatedBy": "6650f1c2a9e4b1d2c3f40a30",      "createdAt": "2026-11-02T09:30:00.000Z",      "updatedAt": "2026-11-02T09:30:00.000Z"    }  ]}

Adds a menu

POST/organisations/{organisationId}/spaces/{spaceId}/navigationKey required

Adds a menu. Permission: navigation:manage.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • Idempotency-Keystringheader

    Optional. A unique value, such as a UUID, that makes a retry safe: the same key with the same request within 24 hours returns the first answer again, with Idempotent-Replayed: true, instead of making the change twice. The same key with a different request gets 422; while the first request is still running, 409. Only successful answers are kept.

    Up to 255 characters.

Request body

  • environmentIdstringrequired

    An id.

  • keystringrequired

    Such as main.

    Up to 64 characters.
  • namestringrequired

    Up to 200 characters.
  • kindstringoptional

    One of header, footer, mobile, custom. Default "custom".
  • regionIdstring or nulloptional

    Only in this region, or null for all.

  • localeIdstring or nulloptional

    Only in this language, or null for all.

  • itemsany[]optional

    Menu items: each { label, kind, contentId or folderId or href, target, icon, badge, description, visible, children }. At most 4 levels.

Responses

  • 201CreatedThe menu.
    • dataMenu

      Fields of data
      • _idstring

        An id.

      • organisationIdstring

        An id.

      • spaceIdstring

        An id.

      • environmentIdstring

        An id.

      • regionIdstring or null

        An id.

      • localeIdstring or null

        An id.

      • keystring

        Such as main.

      • namestring

      • kindstring

        One of header, footer, mobile, custom.
      • itemsMenuItem[]

        Fields of MenuItem

      • createdBystring

        An id.

      • updatedBystring

        An id.

      • createdAtstring

      • updatedAtstring

  • 400Bad requestThe body isn't valid JSON. Or items nest more than 4 levels.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 403ForbiddenLacks navigation:manage, or the token is read only.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 404Not foundNo such space, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 409ConflictA menu with the key exists in the environment.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 422UnprocessableThe body doesn't match the schema. Each problem is in error.details.issues.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 500Server errorSomething went wrong on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

Shell
curl -X POST 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/navigation' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"environmentId":"6650f1c2a9e4b1d2c3f40a13","key":"main","name":"Main menu","kind":"header","items":[{"label":"Trips","kind":"folder","folderId":"6650f1c2a9e4b1d2c3f40a20"},{"label":"Gear","kind":"external","href":"https://northwilds.com/gear"}]}'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

Example answer

201 CreatedJSON
{  "data": {    "_id": "6650f1c2a9e4b1d2c3f40a44",    "organisationId": "6650f1c2a9e4b1d2c3f40a01",    "spaceId": "6650f1c2a9e4b1d2c3f40a02",    "environmentId": "6650f1c2a9e4b1d2c3f40a13",    "regionId": "6650f1c2a9e4b1d2c3f40a17",    "localeId": "6650f1c2a9e4b1d2c3f40a18",    "key": "main",    "name": "Main menu",    "kind": "header",    "items": [      {        "id": "6650f1c2a9e4b1d2c3f40a48",        "label": "Trips",        "kind": "folder",        "contentId": "6650f1c2a9e4b1d2c3f40a21",        "folderId": "6650f1c2a9e4b1d2c3f40a20",        "href": null,        "target": "_self",        "icon": null,        "badge": null,        "description": "Six days of paddling between the peaks of Lofoten.",        "visible": true,        "travel": {          "id": "6650f1c2a9e4b1d2c3f40a40",          "name": "Lofoten sea kayaking",          "kind": "country"        },        "children": []      }    ],    "createdBy": "6650f1c2a9e4b1d2c3f40a30",    "updatedBy": "6650f1c2a9e4b1d2c3f40a30",    "createdAt": "2026-11-02T09:30:00.000Z",    "updatedAt": "2026-11-02T09:30:00.000Z"  }}

Deletes it

DELETE/organisations/{organisationId}/spaces/{spaceId}/navigation/{navigationId}Key required

Deletes it. Permission: navigation:manage.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • navigationIdstringpath, required

    The navigation's id.

Responses

  • 204No contentDone, nothing to return.
  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 403ForbiddenLacks navigation:manage, or the token is read only.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 404Not foundNo such navigation, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 500Server errorSomething went wrong on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

Shell
curl -X DELETE 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/navigation/6650f1c2a9e4b1d2c3f40a30' \  -H 'Authorization: Bearer cms_mt_…'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

Changes its name, kind or items

PATCH/organisations/{organisationId}/spaces/{spaceId}/navigation/{navigationId}Key required

Changes its name, kind or items. Permission: navigation:manage.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • navigationIdstringpath, required

    The navigation's id.

  • Idempotency-Keystringheader

    Optional. A unique value, such as a UUID, that makes a retry safe: the same key with the same request within 24 hours returns the first answer again, with Idempotent-Replayed: true, instead of making the change twice. The same key with a different request gets 422; while the first request is still running, 409. Only successful answers are kept.

    Up to 255 characters.

Request body, optional

  • namestringoptional

    Up to 200 characters.
  • kindstringoptional

    One of header, footer, mobile, custom.
  • itemsany[]optional

    Replaces every item.

Responses

  • 200OKThe menu.
    • dataMenu

      Fields of data
      • _idstring

        An id.

      • organisationIdstring

        An id.

      • spaceIdstring

        An id.

      • environmentIdstring

        An id.

      • regionIdstring or null

        An id.

      • localeIdstring or null

        An id.

      • keystring

        Such as main.

      • namestring

      • kindstring

        One of header, footer, mobile, custom.
      • itemsMenuItem[]

        Fields of MenuItem

      • createdBystring

        An id.

      • updatedBystring

        An id.

      • createdAtstring

      • updatedAtstring

  • 400Bad requestThe body isn't valid JSON. Or items nest more than 4 levels.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 403ForbiddenLacks navigation:manage, or the token is read only.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 404Not foundNo such navigation, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 422UnprocessableThe body doesn't match the schema. Each problem is in error.details.issues.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 500Server errorSomething went wrong on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

Shell
curl -X PATCH 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/navigation/6650f1c2a9e4b1d2c3f40a30' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"name":"Main menu","items":[{"label":"Trips","kind":"folder","folderId":"6650f1c2a9e4b1d2c3f40a20"}]}'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

Example answer

200 OKJSON
{  "data": {    "_id": "6650f1c2a9e4b1d2c3f40a44",    "organisationId": "6650f1c2a9e4b1d2c3f40a01",    "spaceId": "6650f1c2a9e4b1d2c3f40a02",    "environmentId": "6650f1c2a9e4b1d2c3f40a13",    "regionId": "6650f1c2a9e4b1d2c3f40a17",    "localeId": "6650f1c2a9e4b1d2c3f40a18",    "key": "main",    "name": "Main menu",    "kind": "header",    "items": [      {        "id": "6650f1c2a9e4b1d2c3f40a48",        "label": "Trips",        "kind": "folder",        "contentId": "6650f1c2a9e4b1d2c3f40a21",        "folderId": "6650f1c2a9e4b1d2c3f40a20",        "href": null,        "target": "_self",        "icon": null,        "badge": null,        "description": "Six days of paddling between the peaks of Lofoten.",        "visible": true,        "travel": {          "id": "6650f1c2a9e4b1d2c3f40a40",          "name": "Lofoten sea kayaking",          "kind": "country"        },        "children": []      }    ],    "createdBy": "6650f1c2a9e4b1d2c3f40a30",    "updatedBy": "6650f1c2a9e4b1d2c3f40a30",    "createdAt": "2026-11-02T09:30:00.000Z",    "updatedAt": "2026-11-02T09:30:00.000Z"  }}

SchemasThe shapes the endpoints above answer with and take.

Error

Every error has this shape. Write code against code and the status, never the message.

  • errorobject

    Fields of error
    • codestring

      One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
    • messagestring

      Follows Accept-Language when CMS Orbit has the language.

    • detailsanysometimes

      When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

MenuItem

  • idstring

  • labelstring

  • kindstring

    One of content, folder, external, custom, trip, destination, guide.
  • contentIdstring or null

    An id.

  • folderIdstring or null

    An id.

  • hrefstring or null

  • targetstring or null

    One of _self, _blank.
  • iconstring or null

  • badgestring or null

  • descriptionstring or nullsometimes

  • visibleboolean

  • travelobject or nullsometimes

    Fields of travel
    • idstring

    • namestring

    • kindstringsometimes

      One of country, continent.
  • childrenMenuItem[]

    The same shape as MenuItem

Menu

  • _idstring

    An id.

  • organisationIdstring

    An id.

  • spaceIdstring

    An id.

  • environmentIdstring

    An id.

  • regionIdstring or null

    An id.

  • localeIdstring or null

    An id.

  • keystring

    Such as main.

  • namestring

  • kindstring

    One of header, footer, mobile, custom.
  • itemsMenuItem[]

    Fields of MenuItem

  • createdBystring

    An id.

  • updatedBystring

    An id.

  • createdAtstring

  • updatedAtstring