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.
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.
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.
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.
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.
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.
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.
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
200 OKJSON
1{2"data": {3"_id": "6650f1c2a9e4b1d2c3f40a44",4"organisationId": "6650f1c2a9e4b1d2c3f40a01",5"spaceId": "6650f1c2a9e4b1d2c3f40a02",6"environmentId": "6650f1c2a9e4b1d2c3f40a13",7"regionId": "6650f1c2a9e4b1d2c3f40a17",8"localeId": "6650f1c2a9e4b1d2c3f40a18",9"key": "main",10"name": "Main menu",11"kind": "header",12"items": [13 {14"id": "6650f1c2a9e4b1d2c3f40a48",15"label": "Trips",16"kind": "folder",17"contentId": "6650f1c2a9e4b1d2c3f40a21",18"folderId": "6650f1c2a9e4b1d2c3f40a20",19"href": null,20"target": "_self",21"icon": null,22"badge": null,23"description": "Six days of paddling between the peaks of Lofoten.",24"visible": true,25"travel": {26"id": "6650f1c2a9e4b1d2c3f40a40",27"name": "Lofoten sea kayaking",28"kind": "country"29 },30"children": []31 }32 ],33"createdBy": "6650f1c2a9e4b1d2c3f40a30",34"updatedBy": "6650f1c2a9e4b1d2c3f40a30",35"createdAt": "2026-11-02T09:30:00.000Z",36"updatedAt": "2026-11-02T09:30:00.000Z"37 }38}
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.