Spaces
Spaces in the management API. 15 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.
Creates a website in one go: space, environments, regions and languages
POST/organisations/{organisationId}/setupKey required
Creates a website in one go: space, environments, regions and languages. Permission: space:create.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
Idempotency-KeystringheaderOptional. 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
Up to 80 characters.namestringrequired
Default "business". Up to 40 characters.templatestringoptionalenvironmentsstring[]requiredAny of staging and production.
regionsobject[]requiredEach region key must already exist in the organisation in Bifröst Orbit.
Fields of regions
keystringrequiredlanguagesobject[]requiredFields of languages
Up to 20 characters.codestringrequired
Up to 60 characters.namestringrequired
previewUrlstring or nulloptional
Responses
201Created{ spaceId, environmentId }.dataobjectFields of data
spaceIdstringAn id.
environmentIdstring or nullThe first environment's id.
400Bad requestThe body isn't valid JSON.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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 space:create, or the plan's websites or environments are used up.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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 organisation, or it's in another organisation.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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, or a region key the organisation doesn't have.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
curl -X POST 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/setup' \ -H 'Authorization: Bearer cms_mt_…' \ -H 'Content-Type: application/json' \ -d '{"name":"Northwilds","template":"business","environments":["staging","production"],"regions":[{"key":"norway","languages":[{"code":"nb-NO","name":"Norsk"},{"code":"en-GB","name":"English"}]}],"previewUrl":"https://northwilds.com/api/preview"}'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": { "spaceId": "6650f1c2a9e4b1d2c3f40a02", "environmentId": "6650f1c2a9e4b1d2c3f40a13" }}The spaces the token reaches
GET/organisations/{organisationId}/spacesKey required
The spaces the token reaches. include=summary adds environments, counts and page totals. Permission: space:read.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
includestringquerysummary adds environments, region and language counts, page totals and a snapshot of the website.
Only summary.
Responses
200OKList of spaces.dataSpace or SpaceSummary[]Spaces, or with include=summary, SpaceSummary objects.
Fields of data
Spaces, or with include=summary, SpaceSummary objects.
401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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 space:read.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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 organisation, or it's in another organisation.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
curl 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces' \ -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
{ "data": [ { "id": "6650f1c2a9e4b1d2c3f40a40", "organisationId": "6650f1c2a9e4b1d2c3f40a01", "name": "Lofoten sea kayaking", "slug": "lofoten-sea-kayaking", "description": "Six days of paddling between the peaks of Lofoten.", "logoUrl": null, "defaultEnvironmentId": null, "settings": { "autoRedirectOnUrlChange": true, "localeFallbackEnabled": true, "machineTranslation": true, "previewUrl": null, "previewUrls": [ { "name": "Lofoten sea kayaking", "url": "https://northwilds.com/trips/lofoten-sea-kayaking" } ], "previewDevices": [ { "name": "Lofoten sea kayaking", "width": 1 } ], "timezone": "Europe/Oslo", "regionFallback": null, "trashRetentionDays": 30, "seo": { "xDefaultRegion": null, "organisationName": null, "socialProfiles": [ "…" ], "robotsTxt": null, "titleTemplate": null, "defaultDescription": null, "defaultImage": null, "twitterHandle": null, "verification": { "google": null, "bing": null }, "websitePaths": [ "…" ], "indexNow": false }, "indexNowKey": "…", "accessibility": { "publish": "off", "tags": [ "…" ] }, "insights": { "site": "…", "name": "Lofoten sea kayaking" }, "workflowStages": [ { "id": "6650f1c2a9e4b1d2c3f40a40", "name": "Lofoten sea kayaking", "colour": "…" } ], "travel": { "brandId": "6650f1c2a9e4b1d2c3f40a57", "bookingSlug": "…", "brandName": "Northwilds", "siteUrl": "https://northwilds.com", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "commerce": { "storeSlug": "…", "brandName": "Northwilds", "siteUrl": "https://northwilds.com", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "booking": { "locationId": "6650f1c2a9e4b1d2c3f40a5a", "slug": "lofoten-sea-kayaking", "locationName": "…", "siteUrl": "https://northwilds.com", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "presenceOrbit": { "siteSlug": "…", "brandName": "Northwilds", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "careers": { "siteSlug": "…", "name": "Lofoten sea kayaking", "siteUrl": "https://northwilds.com", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "experiments": { "assignment": "cookieless" } }, "createdAt": "2026-11-02T09:30:00.000Z", "updatedAt": "2026-11-02T09:30:00.000Z" } ]}Creates a space
POST/organisations/{organisationId}/spacesKey required
Creates a space. Permission: space:create.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
Idempotency-KeystringheaderOptional. 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
namestringrequiredThe website's name, such as Northwilds.
Up to 200 characters.templatestringoptionalOne of business, blog, landing, shop, travel, local, careers, help or blank. Each adds a content model with sample pages; blank adds only the Page type.
slugstringoptional
Up to 2000 characters.descriptionstring or nulloptionalsettingsobjectoptionalFields of settings
Default true.autoRedirectOnUrlChangebooleanoptional
Default true.localeFallbackEnabledbooleanoptional
Default true.machineTranslationbooleanoptional
Default null.previewUrlstring or nulloptional
Default []. Up to 10 items.previewUrlsobject[]optionalFields of previewUrls
Up to 60 characters.namestringrequiredurlstringrequired
Default []. Up to 6 items.previewDevicesobject[]optionalFields of previewDevices
Up to 30 characters.namestringrequired
At least 240. At most 3840.widthintegerrequired
Default "UTC".timezonestringoptional
Default null. Up to 60 characters.regionFallbackstring or nulloptional
One of 30, 60, 90. Default null.trashRetentionDaysnumber or nulloptional
environmentsobject[]optionalDefaults to Staging and Production. Production is protected.
Fields of environments
keystringrequired
Up to 200 characters.namestringrequired
One of staging, production, custom. Default "custom".kindstringoptional
Responses
201CreatedThe space and its environments.dataobjectThe space, with its environments.
Fields of data
idstringAn id.
organisationIdstringAn id.
namestringslugstringdescriptionstring or nulllogoUrlstring or nulldefaultEnvironmentIdstring or nullAn id.
settingsSpaceSettingscreatedAtstringupdatedAtstringenvironmentsEnvironment[]
400Bad requestThe body isn't valid JSON.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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 space:create, or the plan's websites are used up.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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 organisation, or it's in another organisation.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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 space with the slug exists.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
curl -X POST 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces' \ -H 'Authorization: Bearer cms_mt_…' \ -H 'Content-Type: application/json' \ -d '{"name":"Northwilds","description":"Trips and gear for the far north.","settings":{"timezone":"Europe/Oslo"}}'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": { "id": "6650f1c2a9e4b1d2c3f40a40", "organisationId": "6650f1c2a9e4b1d2c3f40a01", "name": "Lofoten sea kayaking", "slug": "lofoten-sea-kayaking", "description": "Six days of paddling between the peaks of Lofoten.", "logoUrl": null, "defaultEnvironmentId": null, "settings": { "autoRedirectOnUrlChange": true, "localeFallbackEnabled": true, "machineTranslation": true, "previewUrl": null, "previewUrls": [ { "name": "Lofoten sea kayaking", "url": "https://northwilds.com/trips/lofoten-sea-kayaking" } ], "previewDevices": [ { "name": "Lofoten sea kayaking", "width": 1 } ], "timezone": "Europe/Oslo", "regionFallback": null, "trashRetentionDays": 30, "seo": { "xDefaultRegion": null, "organisationName": null, "socialProfiles": [ "…" ], "robotsTxt": null, "titleTemplate": null, "defaultDescription": null, "defaultImage": null, "twitterHandle": null, "verification": { "google": null, "bing": null }, "websitePaths": [ "…" ], "indexNow": false }, "indexNowKey": "…", "accessibility": { "publish": "off", "tags": [ "…" ] }, "insights": { "site": "…", "name": "Lofoten sea kayaking" }, "workflowStages": [ { "id": "6650f1c2a9e4b1d2c3f40a40", "name": "Lofoten sea kayaking", "colour": "…" } ], "travel": { "brandId": "6650f1c2a9e4b1d2c3f40a57", "bookingSlug": "…", "brandName": "Northwilds", "siteUrl": "https://northwilds.com", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "commerce": { "storeSlug": "…", "brandName": "Northwilds", "siteUrl": "https://northwilds.com", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "booking": { "locationId": "6650f1c2a9e4b1d2c3f40a5a", "slug": "lofoten-sea-kayaking", "locationName": "…", "siteUrl": "https://northwilds.com", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "presenceOrbit": { "siteSlug": "…", "brandName": "Northwilds", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "careers": { "siteSlug": "…", "name": "Lofoten sea kayaking", "siteUrl": "https://northwilds.com", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "experiments": { "assignment": "cookieless" } }, "createdAt": "2026-11-02T09:30:00.000Z", "updatedAt": "2026-11-02T09:30:00.000Z", "environments": [ { "id": "6650f1c2a9e4b1d2c3f40a13", "spaceId": "6650f1c2a9e4b1d2c3f40a02", "key": "production", "name": "Production", "kind": "production", "isDefault": true, "protected": false, "sortOrder": 1 } ] }}Moves the space to the bin
DELETE/organisations/{organisationId}/spaces/{spaceId}Key required
Moves the space to the bin. Permission: space:delete.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space'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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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 space:delete, or the token is read only.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
curl -X DELETE 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02' \ -H 'Authorization: Bearer cms_mt_…'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
One space
GET/organisations/{organisationId}/spaces/{spaceId}Key required
One space. Permission: space:read.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
Responses
200OKThe space.dataSpaceFields of data
idstringAn id.
organisationIdstringAn id.
namestringslugstringdescriptionstring or nulllogoUrlstring or nulldefaultEnvironmentIdstring or nullAn id.
settingsSpaceSettingscreatedAtstringupdatedAtstring
401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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 space:read.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
curl 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02' \ -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
{ "data": { "id": "6650f1c2a9e4b1d2c3f40a02", "organisationId": "6650f1c2a9e4b1d2c3f40a01", "name": "Northwilds website", "slug": "northwilds-website", "description": "Trips and gear for the far north.", "logoUrl": null, "defaultEnvironmentId": null, "settings": { "autoRedirectOnUrlChange": true, "localeFallbackEnabled": true, "machineTranslation": true, "previewUrl": null, "previewUrls": [ { "name": "Lofoten sea kayaking", "url": "https://northwilds.com/trips/lofoten-sea-kayaking" } ], "previewDevices": [ { "name": "Lofoten sea kayaking", "width": 1 } ], "timezone": "Europe/Oslo", "regionFallback": null, "trashRetentionDays": 30, "seo": { "xDefaultRegion": null, "organisationName": null, "socialProfiles": [ "…" ], "robotsTxt": null, "titleTemplate": null, "defaultDescription": null, "defaultImage": null, "twitterHandle": null, "verification": { "google": null, "bing": null }, "websitePaths": [ "…" ], "indexNow": false }, "indexNowKey": "…", "accessibility": { "publish": "off", "tags": [ "…" ] }, "insights": { "site": "…", "name": "Lofoten sea kayaking" }, "workflowStages": [ { "id": "6650f1c2a9e4b1d2c3f40a40", "name": "Lofoten sea kayaking", "colour": "…" } ], "travel": { "brandId": "6650f1c2a9e4b1d2c3f40a57", "bookingSlug": "…", "brandName": "Northwilds", "siteUrl": "https://northwilds.com", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "commerce": { "storeSlug": "…", "brandName": "Northwilds", "siteUrl": "https://northwilds.com", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "booking": { "locationId": "6650f1c2a9e4b1d2c3f40a5a", "slug": "lofoten-sea-kayaking", "locationName": "…", "siteUrl": "https://northwilds.com", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "presenceOrbit": { "siteSlug": "…", "brandName": "Northwilds", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "careers": { "siteSlug": "…", "name": "Lofoten sea kayaking", "siteUrl": "https://northwilds.com", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "experiments": { "assignment": "cookieless" } }, "createdAt": "2026-11-02T09:30:00.000Z", "updatedAt": "2026-11-02T09:30:00.000Z" }}Changes its name, description, default environment or settings
PATCH/organisations/{organisationId}/spaces/{spaceId}Key required
Changes its name, description, default environment or settings. Permission: space:update.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
Idempotency-KeystringheaderOptional. 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
Up to 200 characters.namestringoptional
Up to 2000 characters.descriptionstring or nulloptionaldefaultEnvironmentIdstring or nulloptionalAn id.
settingsobjectoptionalMerged into the existing settings.
Fields of settings
autoRedirectOnUrlChangebooleanoptionallocaleFallbackEnabledbooleanoptionalmachineTranslationbooleanoptionalpreviewUrlstring or nulloptional
Up to 10 items.previewUrlsobject[]optionalFields of previewUrls
Up to 60 characters.namestringrequiredurlstringrequired
Up to 6 items.previewDevicesobject[]optionalFields of previewDevices
Up to 30 characters.namestringrequired
At least 240. At most 3840.widthintegerrequired
timezonestringoptional
Up to 60 characters.regionFallbackstring or nulloptional
One of 30, 60, 90.trashRetentionDaysnumber or nulloptional
Up to 12 items.workflowStagesobject[]optionalFields of workflowStages
idstringrequired
Up to 40 characters.namestringrequiredcolourstringrequired
Responses
200OKThe space.dataSpaceFields of data
idstringAn id.
organisationIdstringAn id.
namestringslugstringdescriptionstring or nulllogoUrlstring or nulldefaultEnvironmentIdstring or nullAn id.
settingsSpaceSettingscreatedAtstringupdatedAtstring
400Bad requestThe body isn't valid JSON.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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 space:update, or the token is read only.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
curl -X PATCH 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02' \ -H 'Authorization: Bearer cms_mt_…' \ -H 'Content-Type: application/json' \ -d '{"description":"Trips and gear for the far north.","settings":{"timezone":"Europe/Oslo","previewUrl":"https://northwilds.com/api/preview"}}'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": { "id": "6650f1c2a9e4b1d2c3f40a02", "organisationId": "6650f1c2a9e4b1d2c3f40a01", "name": "Northwilds website", "slug": "northwilds-website", "description": "Trips and gear for the far north.", "logoUrl": null, "defaultEnvironmentId": null, "settings": { "autoRedirectOnUrlChange": true, "localeFallbackEnabled": true, "machineTranslation": true, "previewUrl": null, "previewUrls": [ { "name": "Lofoten sea kayaking", "url": "https://northwilds.com/trips/lofoten-sea-kayaking" } ], "previewDevices": [ { "name": "Lofoten sea kayaking", "width": 1 } ], "timezone": "Europe/Oslo", "regionFallback": null, "trashRetentionDays": 30, "seo": { "xDefaultRegion": null, "organisationName": null, "socialProfiles": [ "…" ], "robotsTxt": null, "titleTemplate": null, "defaultDescription": null, "defaultImage": null, "twitterHandle": null, "verification": { "google": null, "bing": null }, "websitePaths": [ "…" ], "indexNow": false }, "indexNowKey": "…", "accessibility": { "publish": "off", "tags": [ "…" ] }, "insights": { "site": "…", "name": "Lofoten sea kayaking" }, "workflowStages": [ { "id": "6650f1c2a9e4b1d2c3f40a40", "name": "Lofoten sea kayaking", "colour": "…" } ], "travel": { "brandId": "6650f1c2a9e4b1d2c3f40a57", "bookingSlug": "…", "brandName": "Northwilds", "siteUrl": "https://northwilds.com", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "commerce": { "storeSlug": "…", "brandName": "Northwilds", "siteUrl": "https://northwilds.com", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "booking": { "locationId": "6650f1c2a9e4b1d2c3f40a5a", "slug": "lofoten-sea-kayaking", "locationName": "…", "siteUrl": "https://northwilds.com", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "presenceOrbit": { "siteSlug": "…", "brandName": "Northwilds", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "careers": { "siteSlug": "…", "name": "Lofoten sea kayaking", "siteUrl": "https://northwilds.com", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "experiments": { "assignment": "cookieless" } }, "createdAt": "2026-11-02T09:30:00.000Z", "updatedAt": "2026-11-02T09:30:00.000Z" }}Copies a space
POST/organisations/{organisationId}/spaces/{spaceId}/cloneKey required
Copies a space. Permission: space:clone.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
Idempotency-KeystringheaderOptional. 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
namestringrequiredThe copy's name. Required.
schemabooleanoptionalCopy content types, components and taxonomies. Default true.
structurebooleanoptionalCopy regions and languages. Default true.
contentbooleanoptionalCopy pages, as drafts. Default false.
Responses
201CreatedWhat was copied.dataobjectFields of data
spaceIdstringThe new space's id.
namestringcopiedmap of integerHow many of each were copied, such as contentTypes and content.
400Bad requestThe body isn't valid JSON. Or no name.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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 space:clone, or the plan's websites are used up.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
curl -X POST 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/clone' \ -H 'Authorization: Bearer cms_mt_…' \ -H 'Content-Type: application/json' \ -d '{"name":"Northwilds winter campaign","content":true}'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": { "spaceId": "6650f1c2a9e4b1d2c3f40a02", "name": "Lofoten sea kayaking", "copied": {} }}Downloads the space as JSON
GET/organisations/{organisationId}/spaces/{spaceId}/exportKey required
Downloads the space as JSON. Permission: space:clone.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
Responses
200OKAn attachment, named after the space and the day.format"cms-orbit-export"version1exportedAtstringspacemap of anyThe space's name, slug and settings.
collectionsmap of any[]Every environment, region, language, content type, component, taxonomy, term, folder, page, menu, redirect, domain, media folder and file.
401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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 space:clone.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
curl 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/export' \ -H 'Authorization: Bearer cms_mt_…'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Adds content types, components and taxonomies from an export
POST/organisations/{organisationId}/spaces/{spaceId}/importKey required
Adds content types, components and taxonomies from an export. Permission: schema:manage.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
Idempotency-KeystringheaderOptional. 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
fileanyrequiredThe export, as GET {space}/export answers it.
applybooleanoptionalfalse (the default) only reports what would happen. true does it.
Responses
200OKWhat was or would be added.dataobjectFields of data
appliedbooleanitemsobject[]Items that exist are skipped, never overwritten.
Fields of items
One of contentType, component, taxonomy.kindstringkeystringnamestring
One of add, exists, error.outcomestringmessagestring or null
400Bad requestThe body isn't valid JSON. Or file isn't a CMS Orbit export.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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 schema:manage, or the token is read only.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
curl -X POST 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/import' \ -H 'Authorization: Bearer cms_mt_…' \ -H 'Content-Type: application/json' \ -d '{"file":{"format":"cms-orbit-export","version":1},"apply":false}'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": { "applied": false, "items": [ { "kind": "contentType", "key": "lofoten", "name": "Lofoten sea kayaking", "outcome": "add", "message": null } ] }}Adds pages from an export
POST/organisations/{organisationId}/spaces/{spaceId}/import/contentKey required
Adds pages from an export. Permission: space:clone.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
Idempotency-KeystringheaderOptional. 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
fileanyrequiredThe export, as GET {space}/export answers it.
applybooleanoptionalfalse (the default) only reports what would happen. true does it.
Responses
200OKWhat was or would be added.dataobjectFields of data
appliedbooleanitemsobject[]Pages are matched by environment key, region key and language code.
Fields of items
namestringurlstring or nullwherestringThe environment, region and language it goes to.
One of add, exists, error.outcomestringmessagestring or null
400Bad requestThe body isn't valid JSON. Or file isn't a CMS Orbit export.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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 space:clone, or the token is read only.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
curl -X POST 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/import/content' \ -H 'Authorization: Bearer cms_mt_…' \ -H 'Content-Type: application/json' \ -d '{"file":{"format":"cms-orbit-export","version":1},"apply":true}'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": { "applied": false, "items": [ { "name": "Lofoten sea kayaking", "url": "https://northwilds.com/trips/lofoten-sea-kayaking", "where": "…", "outcome": "add", "message": null } ] }}Removes the logo
DELETE/organisations/{organisationId}/spaces/{spaceId}/logoKey required
Removes the logo. Permission: space:update.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
Responses
200OKThe space.dataSpaceFields of data
idstringAn id.
organisationIdstringAn id.
namestringslugstringdescriptionstring or nulllogoUrlstring or nulldefaultEnvironmentIdstring or nullAn id.
settingsSpaceSettingscreatedAtstringupdatedAtstring
401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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 space:update, or the token is read only.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
curl -X DELETE 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/logo' \ -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
{ "data": { "id": "6650f1c2a9e4b1d2c3f40a02", "organisationId": "6650f1c2a9e4b1d2c3f40a01", "name": "Northwilds website", "slug": "northwilds-website", "description": "Trips and gear for the far north.", "logoUrl": null, "defaultEnvironmentId": null, "settings": { "autoRedirectOnUrlChange": true, "localeFallbackEnabled": true, "machineTranslation": true, "previewUrl": null, "previewUrls": [ { "name": "Lofoten sea kayaking", "url": "https://northwilds.com/trips/lofoten-sea-kayaking" } ], "previewDevices": [ { "name": "Lofoten sea kayaking", "width": 1 } ], "timezone": "Europe/Oslo", "regionFallback": null, "trashRetentionDays": 30, "seo": { "xDefaultRegion": null, "organisationName": null, "socialProfiles": [ "…" ], "robotsTxt": null, "titleTemplate": null, "defaultDescription": null, "defaultImage": null, "twitterHandle": null, "verification": { "google": null, "bing": null }, "websitePaths": [ "…" ], "indexNow": false }, "indexNowKey": "…", "accessibility": { "publish": "off", "tags": [ "…" ] }, "insights": { "site": "…", "name": "Lofoten sea kayaking" }, "workflowStages": [ { "id": "6650f1c2a9e4b1d2c3f40a40", "name": "Lofoten sea kayaking", "colour": "…" } ], "travel": { "brandId": "6650f1c2a9e4b1d2c3f40a57", "bookingSlug": "…", "brandName": "Northwilds", "siteUrl": "https://northwilds.com", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "commerce": { "storeSlug": "…", "brandName": "Northwilds", "siteUrl": "https://northwilds.com", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "booking": { "locationId": "6650f1c2a9e4b1d2c3f40a5a", "slug": "lofoten-sea-kayaking", "locationName": "…", "siteUrl": "https://northwilds.com", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "presenceOrbit": { "siteSlug": "…", "brandName": "Northwilds", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "careers": { "siteSlug": "…", "name": "Lofoten sea kayaking", "siteUrl": "https://northwilds.com", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "experiments": { "assignment": "cookieless" } }, "createdAt": "2026-11-02T09:30:00.000Z", "updatedAt": "2026-11-02T09:30:00.000Z" }}Uploads the logo: multipart/form-data with file, PNG, JPEG or WebP, up to 2 MB
POST/organisations/{organisationId}/spaces/{spaceId}/logoKey required
Uploads the logo: multipart/form-data with file, PNG, JPEG or WebP, up to 2 MB. SVG is refused. Permission: space:update.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
Idempotency-KeystringheaderOptional. 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
filestringrequiredA PNG, JPEG or WebP image, up to 2 MB. SVG is refused.
Responses
200OKThe space.dataSpaceFields of data
idstringAn id.
organisationIdstringAn id.
namestringslugstringdescriptionstring or nulllogoUrlstring or nulldefaultEnvironmentIdstring or nullAn id.
settingsSpaceSettingscreatedAtstringupdatedAtstring
400Bad requestNot multipart/form-data, no file, a type other than PNG, JPEG or WebP, or over 2 MB.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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 space:update, or the token is read only.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
curl -X POST 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/logo' \ -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
{ "data": { "id": "6650f1c2a9e4b1d2c3f40a02", "organisationId": "6650f1c2a9e4b1d2c3f40a01", "name": "Northwilds website", "slug": "northwilds-website", "description": "Trips and gear for the far north.", "logoUrl": null, "defaultEnvironmentId": null, "settings": { "autoRedirectOnUrlChange": true, "localeFallbackEnabled": true, "machineTranslation": true, "previewUrl": null, "previewUrls": [ { "name": "Lofoten sea kayaking", "url": "https://northwilds.com/trips/lofoten-sea-kayaking" } ], "previewDevices": [ { "name": "Lofoten sea kayaking", "width": 1 } ], "timezone": "Europe/Oslo", "regionFallback": null, "trashRetentionDays": 30, "seo": { "xDefaultRegion": null, "organisationName": null, "socialProfiles": [ "…" ], "robotsTxt": null, "titleTemplate": null, "defaultDescription": null, "defaultImage": null, "twitterHandle": null, "verification": { "google": null, "bing": null }, "websitePaths": [ "…" ], "indexNow": false }, "indexNowKey": "…", "accessibility": { "publish": "off", "tags": [ "…" ] }, "insights": { "site": "…", "name": "Lofoten sea kayaking" }, "workflowStages": [ { "id": "6650f1c2a9e4b1d2c3f40a40", "name": "Lofoten sea kayaking", "colour": "…" } ], "travel": { "brandId": "6650f1c2a9e4b1d2c3f40a57", "bookingSlug": "…", "brandName": "Northwilds", "siteUrl": "https://northwilds.com", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "commerce": { "storeSlug": "…", "brandName": "Northwilds", "siteUrl": "https://northwilds.com", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "booking": { "locationId": "6650f1c2a9e4b1d2c3f40a5a", "slug": "lofoten-sea-kayaking", "locationName": "…", "siteUrl": "https://northwilds.com", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "presenceOrbit": { "siteSlug": "…", "brandName": "Northwilds", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "careers": { "siteSlug": "…", "name": "Lofoten sea kayaking", "siteUrl": "https://northwilds.com", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "experiments": { "assignment": "cookieless" } }, "createdAt": "2026-11-02T09:30:00.000Z", "updatedAt": "2026-11-02T09:30:00.000Z" }}Spaces in the bin
GET/organisations/{organisationId}/trash/spacesKey required
Spaces in the bin. Permission: space:delete.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
Responses
200OKList.dataobject[]Fields of data
idstringAn id.
namestringslugstringlogoUrlstring or nulldeletedAtstringdeletedBystring or nullWho moved it to the bin.
401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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 space:delete.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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 organisation, or it's in another organisation.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
curl 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/trash/spaces' \ -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
{ "data": [ { "id": "6650f1c2a9e4b1d2c3f40a40", "name": "Lofoten sea kayaking", "slug": "lofoten-sea-kayaking", "logoUrl": null, "deletedAt": "2026-11-02T09:30:00.000Z", "deletedBy": "6650f1c2a9e4b1d2c3f40a30" } ]}Erases a space in the bin, with its content and media, for good
DELETE/organisations/{organisationId}/trash/spaces/{trashedSpaceId}Key required
Erases a space in the bin, with its content and media, for good. Permission: space:purge (owners).
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
trashedSpaceIdstringpath, requiredThe id of the space in the bin.
Responses
200OKWhat was erased.dataobjectFields of data
namestringslugstringdocumentsmap of integerHow many of each were erased.
objectsRemovedintegerFiles removed from storage.
400Bad requestThe space isn't in the bin.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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 space:purge, which only owners have.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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 in the bin, or it's in another organisation.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
curl -X DELETE 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/trash/spaces/6650f1c2a9e4b1d2c3f40a02' \ -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
{ "data": { "name": "Lofoten sea kayaking", "slug": "lofoten-sea-kayaking", "documents": {}, "objectsRemoved": 1 }}Takes a space out of the bin
POST/organisations/{organisationId}/trash/spaces/{trashedSpaceId}Key required
Takes a space out of the bin. Permission: space:delete.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
trashedSpaceIdstringpath, requiredThe id of the space in the bin.
Idempotency-KeystringheaderOptional. 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.
Responses
200OKThe space.dataSpaceFields of data
idstringAn id.
organisationIdstringAn id.
namestringslugstringdescriptionstring or nulllogoUrlstring or nulldefaultEnvironmentIdstring or nullAn id.
settingsSpaceSettingscreatedAtstringupdatedAtstring
401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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 space:delete, or the plan's websites are used up.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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 in the bin, or it's in another organisation.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
curl -X POST 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/trash/spaces/6650f1c2a9e4b1d2c3f40a02' \ -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
{ "data": { "id": "6650f1c2a9e4b1d2c3f40a02", "organisationId": "6650f1c2a9e4b1d2c3f40a01", "name": "Northwilds website", "slug": "northwilds-website", "description": "Trips and gear for the far north.", "logoUrl": null, "defaultEnvironmentId": null, "settings": { "autoRedirectOnUrlChange": true, "localeFallbackEnabled": true, "machineTranslation": true, "previewUrl": null, "previewUrls": [ { "name": "Lofoten sea kayaking", "url": "https://northwilds.com/trips/lofoten-sea-kayaking" } ], "previewDevices": [ { "name": "Lofoten sea kayaking", "width": 1 } ], "timezone": "Europe/Oslo", "regionFallback": null, "trashRetentionDays": 30, "seo": { "xDefaultRegion": null, "organisationName": null, "socialProfiles": [ "…" ], "robotsTxt": null, "titleTemplate": null, "defaultDescription": null, "defaultImage": null, "twitterHandle": null, "verification": { "google": null, "bing": null }, "websitePaths": [ "…" ], "indexNow": false }, "indexNowKey": "…", "accessibility": { "publish": "off", "tags": [ "…" ] }, "insights": { "site": "…", "name": "Lofoten sea kayaking" }, "workflowStages": [ { "id": "6650f1c2a9e4b1d2c3f40a40", "name": "Lofoten sea kayaking", "colour": "…" } ], "travel": { "brandId": "6650f1c2a9e4b1d2c3f40a57", "bookingSlug": "…", "brandName": "Northwilds", "siteUrl": "https://northwilds.com", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "commerce": { "storeSlug": "…", "brandName": "Northwilds", "siteUrl": "https://northwilds.com", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "booking": { "locationId": "6650f1c2a9e4b1d2c3f40a5a", "slug": "lofoten-sea-kayaking", "locationName": "…", "siteUrl": "https://northwilds.com", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "presenceOrbit": { "siteSlug": "…", "brandName": "Northwilds", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "careers": { "siteSlug": "…", "name": "Lofoten sea kayaking", "siteUrl": "https://northwilds.com", "connectedAt": "2026-11-02T09:30:00.000Z", "connectedBy": "6650f1c2a9e4b1d2c3f40a30" }, "experiments": { "assignment": "cookieless" } }, "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.
errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
SpaceSettings
autoRedirectOnUrlChangebooleanAdd a redirect when a published page's address changes.
localeFallbackEnabledbooleanmachineTranslationbooleansometimespreviewUrlstring or nullpreviewUrlsobject[]sometimesFields of previewUrls
namestringurlstring
previewDevicesobject[]sometimesFields of previewDevices
namestringwidthinteger
timezonestringAn IANA zone, such as Europe/Oslo.
regionFallbackstring or nullsometimesA region key.
One of 30, 60, 90.trashRetentionDaysinteger or nullsometimesseoSiteSeosometimesindexNowKeystringsometimesThe key search engines check at /<key>.txt on the website before accepting IndexNow pings. Made the first time one is sent.
accessibilityAccessibilitySettingssometimesinsightsobjectsometimesFields of insights
sitestringnamestring
workflowStagesobject[]sometimesFields of workflowStages
idstringnamestringcolourstringSuch as #2f6f4f.
travelobjectsometimesFields of travel
brandIdstringsometimesbookingSlugstringbrandNamestringsiteUrlstringconnectedAtstringconnectedBystring or null
commerceobjectsometimesFields of commerce
storeSlugstringbrandNamestringsiteUrlstringconnectedAtstringconnectedBystring or null
bookingobjectsometimesFields of booking
locationIdstringslugstringlocationNamestringsiteUrlstringconnectedAtstringconnectedBystring or null
presenceOrbitobjectsometimesFields of presenceOrbit
siteSlugstringbrandNamestringconnectedAtstringconnectedBystring or null
careersobjectsometimesFields of careers
siteSlugstringnamestringsiteUrlstringconnectedAtstringconnectedBystring or null
experimentsobjectsometimesFields of experiments
One of cookieless, consent, cookie.assignmentstring
Space
idstringAn id.
organisationIdstringAn id.
namestringslugstringdescriptionstring or nulllogoUrlstring or nulldefaultEnvironmentIdstring or nullAn id.
settingsSpaceSettingscreatedAtstringupdatedAtstring
Environment
idstringAn id.
spaceIdstringAn id.
keystringSuch as production. Never changes.
namestring
One of staging, production, custom.kindstringisDefaultbooleanprotectedbooleanA protected environment can't be deleted.
sortOrderinteger
AccessibilitySettings
publishstringWhether accessibility problems warn or block publishing.
One of off, warn, block.tagsstring[]The rule sets that apply.
SiteSeo
xDefaultRegionstring or nullorganisationNamestring or nullsocialProfilesstring[]robotsTxtstring or nulltitleTemplatestring or nullsometimesSuch as %s | Northwilds.
defaultDescriptionstring or nullsometimesdefaultImagestring or nullsometimesA media id.
twitterHandlestring or nullsometimesverificationobjectsometimesFields of verification
googlestring or nullsometimesbingstring or nullsometimes
websitePathsstring[]sometimesindexNowbooleansometimesTells search engines through IndexNow when a page is published, unpublished, moved or deleted in an environment they may index. On unless switched off.
SpaceSummary
idstringAn id.
namestringslugstringdescriptionstring or nulllogoUrlstring or nullenvironmentsobject[]Fields of environments
idstringAn id.
namestringkeystringkindstring
regionCountintegerlocaleCountintegerupdatedAtstringsnapshotUrlstring or nullA screenshot of the website's home page.
pagesobjectFields of pages
liveintegerchangedintegerPublished pages with unpublished changes.