Content
Content 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.
The content at the top level, or in folderId
GET/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/contentKey required
The content at the top level, or in folderId. Permission: content:read.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
environmentIdstringpath, requiredThe environment's id.
regionIdstringpath, requiredThe region's id.
localeIdstringpath, requiredThe language's id.
folderIdstringqueryA folder's id, or root for the top level. Leave it out for the top level.
urlstringqueryFind content by its address instead. Answers a list with one summary, or an empty list.
externalIdstringqueryFind content by your own id instead, such as its id in the system you migrate from. Repeat it for up to 500 ids. Answers a summary for each one found.
Responses
200OKList of summaries.dataContentSummary[]Fields of data
idstringAn id.
namestringslugstringurlstring or nullSuch as /trips/lofoten-sea-kayaking. null for content without an address.
statusstringpublished once it has been published, even while the draft has changes.
One of draft, in_review, published, scheduled, archived.contentTypeKeystringfolderIdstring or nullAn id.
externalIdstring or nullYour own id for the entry, such as its id in the system it was imported from. Unique in its language.
isGlobalbooleanisFolderIndexbooleanupdatedAtstringpublishedAtstring or null
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 content: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 language, 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/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content' \ -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": "6650f1c2a9e4b1d2c3f40a4e", "name": "Lofoten sea kayaking", "slug": "lofoten-sea-kayaking", "url": "/trips/lofoten-sea-kayaking", "status": "draft", "contentTypeKey": "trip", "folderId": "6650f1c2a9e4b1d2c3f40a20", "externalId": null, "isGlobal": false, "isFolderIndex": false, "updatedAt": "2026-11-02T09:30:00.000Z", "publishedAt": "2026-11-02T09:30:00.000Z" } ]}Creates content as a draft
POST/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/contentKey required
Creates content as a draft. Permission: content:create.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
environmentIdstringpath, requiredThe environment's id.
regionIdstringpath, requiredThe region's id.
localeIdstringpath, requiredThe language's id.
dryRunstringquerytrue checks everything a create checks and answers what it would make, with id null, without saving.
One of true, false.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 name editors see, such as Lofoten sea kayaking.
Up to 200 characters.slugstringoptionalThe last part of the address. From the name when left out.
contentTypeKeystringrequiredOne of the space's content types.
Up to 64 characters.folderIdstring or nulloptionalThe folder it lives in. The folder must accept the content type.
urlOverridestring or nulloptionalA whole address instead of folder and slug, such as /winter.
Up to 500 characters.fieldsmap of anyoptionalField values by key. See the field types guide.
Default {}.componentsany[]optionalBlocks: each { id, type, fields, children, variant }, where children holds slots of further blocks. See the Block schema. Defaults to the content type's template.
Default [].seoobjectoptionalFields of seo
Default null. Up to 200 characters.titlestring or nulloptional
Default null. Up to 500 characters.descriptionstring or nulloptional
Default null. Up to 500 characters.canonicalstring or nulloptional
Default false.noIndexbooleanoptional
Default null. Up to 200 characters.ogTitlestring or nulloptional
Default null. Up to 500 characters.ogDescriptionstring or nulloptional
Default null. Up to 500 characters.ogImagestring or nulloptional
Default null. Up to 200 characters.twitterTitlestring or nulloptional
Default null. Up to 500 characters.twitterDescriptionstring or nulloptional
Default null. Up to 500 characters.twitterImagestring or nulloptional
Default false.noFollowbooleanoptional
Default null. Up to 120 characters.breadcrumbLabelstring or nulloptional
Default false.sitemapExcludebooleanoptional
One of always, hourly, daily, weekly, monthly, yearly, never. Default null.sitemapChangeFrequencystring or nulloptional
Default null. At least 0. At most 1.sitemapPrioritynumber or nulloptional
globalKeystring or nulloptionalThe key a global entry is read by, such as footer.
Up to 64 characters.externalIdstring or nulloptionalYour own id for the entry, up to 200 characters, such as its id in the system you migrate from. Unique in this language: another entry with it answers 409.
Up to 200 characters.isFolderIndexbooleanoptionalThe folder's own page, at the folder's address.
Default false.
Default 0.sortOrderintegeroptional
Responses
201CreatedThe summary.dataContentSummaryFields of data
idstringAn id.
namestringslugstringurlstring or nullSuch as /trips/lofoten-sea-kayaking. null for content without an address.
statusstringpublished once it has been published, even while the draft has changes.
One of draft, in_review, published, scheduled, archived.contentTypeKeystringfolderIdstring or nullAn id.
externalIdstring or nullYour own id for the entry, such as its id in the system it was imported from. Unique in its language.
isGlobalbooleanisFolderIndexbooleanupdatedAtstringpublishedAtstring or null
400Bad requestThe body isn't valid JSON. Or a field value breaks the content type's rules (each in details as { path, message }), the folder doesn't accept the content type, or a link points to a page in the bin or another space.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 content:create, 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 language, 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.
409ConflictThe address or externalId is taken, or the content type allows one item and it 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/6650f1c2a9e4b1d2c3f40a02/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content' \ -H 'Authorization: Bearer cms_mt_…' \ -H 'Content-Type: application/json' \ -d '{"name":"Lofoten sea kayaking","contentTypeKey":"trip","folderId":"6650f1c2a9e4b1d2c3f40a20","fields":{"title":"Lofoten sea kayaking","days":6},"seo":{"description":"Six days of paddling between the peaks of Lofoten."}}'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": { "id": "6650f1c2a9e4b1d2c3f40a4e", "name": "Lofoten sea kayaking", "slug": "lofoten-sea-kayaking", "url": "/trips/lofoten-sea-kayaking", "status": "draft", "contentTypeKey": "trip", "folderId": "6650f1c2a9e4b1d2c3f40a20", "externalId": null, "isGlobal": false, "isFolderIndex": false, "updatedAt": "2026-11-02T09:30:00.000Z", "publishedAt": "2026-11-02T09:30:00.000Z" }}Erases every item of one content type in the bin
DELETE/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/trashKey required
Erases every item of one content type in the bin. Permission: content:purge.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
environmentIdstringpath, requiredThe environment's id.
regionIdstringpath, requiredThe region's id.
localeIdstringpath, requiredThe language's id.
typestringquery, requiredThe content type key to erase, such as trip. Required.
Responses
200OK{ erased }.dataobjectFields of data
erasedintegerHow many items were erased.
400Bad requestNo type.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 content:purge, 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 language, 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/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/trash?type=trip' \ -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": { "erased": 1 }}What is in the bin in this language
GET/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/trashKey required
What is in the bin in this language. Permission: content:delete.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
environmentIdstringpath, requiredThe environment's id.
regionIdstringpath, requiredThe region's id.
localeIdstringpath, requiredThe language's id.
Responses
200OK[{ id, name, url, contentTypeKey, deletedAt, folderName, urlTaken, wasPublished }].dataobject[]Fields of data
idstringAn id.
namestringurlstring or nullThe address it had.
contentTypeKeystringdeletedAtstringfolderNamestring or nullurlTakenbooleanAnother item now uses the address, so restoring gives it a new one.
wasPublishedboolean
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 content: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 language, 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/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/trash' \ -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", "url": "https://northwilds.com/trips/lofoten-sea-kayaking", "contentTypeKey": "…", "deletedAt": "2026-11-02T09:30:00.000Z", "folderName": null, "urlTaken": false, "wasPublished": false } ]}Moves it to the bin
DELETE/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}Key required
Moves it to the bin. redirectTo=/gear also adds a redirect from its live address. Permission: content:delete.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
environmentIdstringpath, requiredThe environment's id.
regionIdstringpath, requiredThe region's id.
localeIdstringpath, requiredThe language's id.
contentIdstringpath, requiredThe content item's id.
redirectTostringqueryAlso add a redirect from its live address to this one, such as /trips.
Responses
204No contentDone, nothing to return.400Bad requestA shared section that pages still use, or a redirect address that isn't valid.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 content: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 content item, 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/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21' \ -H 'Authorization: Bearer cms_mt_…'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
One item with its draft
GET/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}Key required
One item with its draft. Permission: content:read.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
environmentIdstringpath, requiredThe environment's id.
regionIdstringpath, requiredThe region's id.
localeIdstringpath, requiredThe language's id.
contentIdstringpath, requiredThe content item's id.
Responses
200OKThe item.dataContentOne piece of content with its draft.
Fields of data
idstringAn id.
namestringslugstringurlstring or null
One of draft, in_review, published, scheduled, archived.statusstringcontentTypeKeystringfolderIdstring or nullAn id.
externalIdstring or nullisGlobalbooleanisFolderIndexbooleanupdatedAtstringpublishedAtstring or nullurlOverridestring or nulldraftobjectThe draft. No seo for content without an address.
Fields of draft
fieldsmap of anyField values by key. See https://docs.bifrostorbit.com/cms/developers/field-types/.
componentsBlock[]seoobjectsometimesFields of seo
titlestring or nulldescriptionstring or nullcanonicalstring or nullnoIndexbooleanogTitlestring or nullogDescriptionstring or nullogImagestring or nullA media id or address.
twitterTitlestring or nulltwitterDescriptionstring or nulltwitterImagestring or nullnoFollowbooleanbreadcrumbLabelstring or nullsitemapExcludeboolean
One of always, hourly, daily, weekly, monthly, yearly, never.sitemapChangeFrequencystring or null
At least 0. At most 1.sitemapPrioritynumber or null
updatedAtstringupdatedBystringAn id.
draftVersionintegerpublishedVersionintegerCompare with draftVersion to see whether the draft has unpublished changes.
docVersionintegerSend it back with each save, so a save never overwrites changes you haven't seen.
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 content: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 content item, 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/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21' \ -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": "6650f1c2a9e4b1d2c3f40a21", "name": "Lofoten sea kayaking", "slug": "lofoten-sea-kayaking", "url": "/trips/lofoten-sea-kayaking", "status": "draft", "contentTypeKey": "trip", "folderId": "6650f1c2a9e4b1d2c3f40a20", "externalId": null, "isGlobal": false, "isFolderIndex": false, "updatedAt": "2026-11-02T09:30:00.000Z", "publishedAt": "2026-11-02T09:30:00.000Z", "urlOverride": null, "draft": { "fields": {}, "components": [ { "id": "hero-1", "type": "hero", "schemaVersion": 12, "fields": { "heading": "Paddle the Lofoten fjords" }, "children": {}, "variant": null } ], "seo": { "title": "Lofoten sea kayaking", "description": "Six days of paddling between the peaks of Lofoten.", "canonical": null, "noIndex": false, "ogTitle": null, "ogDescription": null, "ogImage": null, "twitterTitle": null, "twitterDescription": null, "twitterImage": null, "noFollow": false, "breadcrumbLabel": null, "sitemapExclude": false, "sitemapChangeFrequency": "always", "sitemapPriority": 0 }, "updatedAt": "2026-11-02T09:30:00.000Z", "updatedBy": "6650f1c2a9e4b1d2c3f40a30" }, "draftVersion": 12, "publishedVersion": 12, "docVersion": 12 }}Saves the draft
PATCH/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}Key required
Saves the draft. Permission: content:update.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
environmentIdstringpath, requiredThe environment's id.
regionIdstringpath, requiredThe region's id.
localeIdstringpath, requiredThe language's id.
contentIdstringpath, requiredThe content item's id.
dryRunstringquerytrue checks everything a save checks and answers the entry as it would be, without saving.
One of true, false.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.namestringoptionalslugstringoptional
Up to 500 characters.urlOverridestring or nulloptionalfolderIdstring or nulloptionalAn id.
fieldsmap of anyoptionalField values by key. Fields you leave out keep their value.
componentsany[]optionalBlocks: each { id, type, fields, children, variant }, where children holds slots of further blocks. See the Block schema.
seoobjectoptionalFields of seo
Up to 200 characters.titlestring or nulloptional
Up to 500 characters.descriptionstring or nulloptional
Up to 500 characters.canonicalstring or nulloptionalnoIndexbooleanoptional
Up to 200 characters.ogTitlestring or nulloptional
Up to 500 characters.ogDescriptionstring or nulloptional
Up to 500 characters.ogImagestring or nulloptional
Up to 200 characters.twitterTitlestring or nulloptional
Up to 500 characters.twitterDescriptionstring or nulloptional
Up to 500 characters.twitterImagestring or nulloptionalnoFollowbooleanoptional
Up to 120 characters.breadcrumbLabelstring or nulloptionalsitemapExcludebooleanoptional
One of always, hourly, daily, weekly, monthly, yearly, never.sitemapChangeFrequencystring or nulloptional
At least 0. At most 1.sitemapPrioritynumber or nulloptional
externalIdstring or nulloptionalYour own id for the entry, or null to remove it. Unique in this language.
Up to 200 characters.isFolderIndexbooleanoptionalsortOrderintegeroptionaldocVersionintegeroptionalThe version you read. A save answers 409 when the page has changed since.
Responses
200OKThe item.dataContentOne piece of content with its draft.
Fields of data
idstringAn id.
namestringslugstringurlstring or null
One of draft, in_review, published, scheduled, archived.statusstringcontentTypeKeystringfolderIdstring or nullAn id.
externalIdstring or nullisGlobalbooleanisFolderIndexbooleanupdatedAtstringpublishedAtstring or nullurlOverridestring or nulldraftobjectThe draft. No seo for content without an address.
Fields of draft
fieldsmap of anyField values by key. See https://docs.bifrostorbit.com/cms/developers/field-types/.
componentsBlock[]seoobjectsometimesFields of seo
titlestring or nulldescriptionstring or nullcanonicalstring or nullnoIndexbooleanogTitlestring or nullogDescriptionstring or nullogImagestring or nullA media id or address.
twitterTitlestring or nulltwitterDescriptionstring or nulltwitterImagestring or nullnoFollowbooleanbreadcrumbLabelstring or nullsitemapExcludeboolean
One of always, hourly, daily, weekly, monthly, yearly, never.sitemapChangeFrequencystring or null
At least 0. At most 1.sitemapPrioritynumber or null
updatedAtstringupdatedBystringAn id.
draftVersionintegerpublishedVersionintegerCompare with draftVersion to see whether the draft has unpublished changes.
docVersionintegerSend it back with each save, so a save never overwrites changes you haven't seen.
400Bad requestThe body isn't valid JSON. Or a field value breaks the content type's rules (each in details as { path, message }), the folder doesn't accept the content type, or a link points to a page in the bin or another space.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 content:update, or changes price, promotion or brand-locked fields without pricing:manage, promotions:manage or brand:manage.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 content item, 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.
409ConflictThe page changed since the docVersion you sent (details has currentVersion, expected and received), someone has it open, the address is taken, or the content type allows one item.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/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21' \ -H 'Authorization: Bearer cms_mt_…' \ -H 'Content-Type: application/json' \ -d '{"docVersion":12,"fields":{"title":"Lofoten sea kayaking","days":6,"priceFrom":18900}}'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": { "id": "6650f1c2a9e4b1d2c3f40a21", "name": "Lofoten sea kayaking", "slug": "lofoten-sea-kayaking", "url": "/trips/lofoten-sea-kayaking", "status": "draft", "contentTypeKey": "trip", "folderId": "6650f1c2a9e4b1d2c3f40a20", "externalId": null, "isGlobal": false, "isFolderIndex": false, "updatedAt": "2026-11-02T09:30:00.000Z", "publishedAt": "2026-11-02T09:30:00.000Z", "urlOverride": null, "draft": { "fields": {}, "components": [ { "id": "hero-1", "type": "hero", "schemaVersion": 12, "fields": { "heading": "Paddle the Lofoten fjords" }, "children": {}, "variant": null } ], "seo": { "title": "Lofoten sea kayaking", "description": "Six days of paddling between the peaks of Lofoten.", "canonical": null, "noIndex": false, "ogTitle": null, "ogDescription": null, "ogImage": null, "twitterTitle": null, "twitterDescription": null, "twitterImage": null, "noFollow": false, "breadcrumbLabel": null, "sitemapExclude": false, "sitemapChangeFrequency": "always", "sitemapPriority": 0 }, "updatedAt": "2026-11-02T09:30:00.000Z", "updatedBy": "6650f1c2a9e4b1d2c3f40a30" }, "draftVersion": 12, "publishedVersion": 12, "docVersion": 12 }}What the Delivery API answers for it
GET/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}/deliveryKey required
What the Delivery API answers for it. draft=true for the draft. Permission: content:read.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
environmentIdstringpath, requiredThe environment's id.
regionIdstringpath, requiredThe region's id.
localeIdstringpath, requiredThe language's id.
contentIdstringpath, requiredThe content item's id.
draftstringquerytrue for what the draft would deliver.
One of true, false.
Responses
200OK{ request, body }.dataobjectFields of data
requeststringThe Delivery API address that answers this, such as /cms/v1/content?url=/trips/lofoten-sea-kayaking.
bodyanyWhat it answers: a Page or, for a global entry, a Global. See https://docs.bifrostorbit.com/reference/cms-delivery/.
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 content: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 content item, 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/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21/delivery' \ -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": { "request": "/cms/v1/content?url=/trips/lofoten-sea-kayaking", "body": null }}What the Delivery API would answer for a draft you send in the body, before saving it
POST/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}/deliveryKey required
What the Delivery API would answer for a draft you send in the body, before saving it. as=banner or as=popup previews a banner or popup; include=references adds referenced entries. Permission: content:read.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
environmentIdstringpath, requiredThe environment's id.
regionIdstringpath, requiredThe region's id.
localeIdstringpath, requiredThe language's id.
contentIdstringpath, requiredThe content item's id.
asstringquerybanner or popup previews the draft as a banner or popup.
One of banner, popup.includestringqueryreferences adds the entries the draft refers to.
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
fieldsmap of anyrequiredThe draft's field values.
componentsBlock[]optionalFields of components
idstringrequiredtypestringrequiredThe component's key, such as hero.
schemaVersionintegerrequiredfieldsmap of anyrequiredThe component's fields.
childrenmap of Block[]requiredFurther blocks by slot.
Fields of children
idstringrequiredtypestringrequiredThe component's key, such as hero.
schemaVersionintegerrequiredfieldsmap of anyrequiredThe component's fields.
childrenmap of Block[]requiredFurther blocks by slot.
Fields of children
idstringrequiredtypestringrequiredThe component's key, such as hero.
schemaVersionintegerrequiredfieldsmap of anyrequiredThe component's fields.
childrenmap of Block[]requiredFurther blocks by slot.
Fields of children
idstringrequiredtypestringrequiredThe component's key, such as hero.
schemaVersionintegerrequiredfieldsmap of anyrequiredThe component's fields.
childrenmap of Block[]requiredFurther blocks by slot.
variantstring or nullrequired
variantstring or nullrequired
variantstring or nullrequired
variantstring or nullrequired
Responses
200OK{ request, body }.dataanyWhat the Delivery API would answer: { fields, components } for a page, or a banner or popup as the Delivery API delivers them. See https://docs.bifrostorbit.com/reference/cms-delivery/.
400Bad requestThe body isn't valid JSON. Or the draft breaks the content type's rules, or as=banner on content that isn't a banner.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 content:read, 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 content item, 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/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21/delivery' \ -H 'Authorization: Bearer cms_mt_…' \ -H 'Content-Type: application/json' \ -d '{"fields":{"title":"Lofoten sea kayaking"},"components":[]}'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": null}Copies it in the same folder, with a new name and address
POST/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}/duplicateKey required
Copies it in the same folder, with a new name and address. includeMedia (default true). Permission: content:copy.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
environmentIdstringpath, requiredThe environment's id.
regionIdstringpath, requiredThe region's id.
localeIdstringpath, requiredThe language's id.
contentIdstringpath, requiredThe content item'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
includeContentbooleanoptionalCopy the fields and blocks.
Default true.includeSeobooleanoptionalCopy the search settings.
Default true.includeMediabooleanoptionalKeep the images and files.
Default true.
Responses
201CreatedThe summary.dataContentSummaryFields of data
idstringAn id.
namestringslugstringurlstring or nullSuch as /trips/lofoten-sea-kayaking. null for content without an address.
statusstringpublished once it has been published, even while the draft has changes.
One of draft, in_review, published, scheduled, archived.contentTypeKeystringfolderIdstring or nullAn id.
externalIdstring or nullYour own id for the entry, such as its id in the system it was imported from. Unique in its language.
isGlobalbooleanisFolderIndexbooleanupdatedAtstringpublishedAtstring or null
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 content:copy, 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 content item, 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 POST 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21/duplicate' \ -H 'Authorization: Bearer cms_mt_…' \ -H 'Content-Type: application/json' \ -d '{"includeMedia":true}'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": { "id": "6650f1c2a9e4b1d2c3f40a4e", "name": "Lofoten sea kayaking", "slug": "lofoten-sea-kayaking", "url": "/trips/lofoten-sea-kayaking", "status": "draft", "contentTypeKey": "trip", "folderId": "6650f1c2a9e4b1d2c3f40a20", "externalId": null, "isGlobal": false, "isFolderIndex": false, "updatedAt": "2026-11-02T09:30:00.000Z", "publishedAt": "2026-11-02T09:30:00.000Z" }}A preview link for the draft, valid for an hour
POST/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}/previewKey required
A preview link for the draft, valid for an hour. Permission: content:read_draft.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
environmentIdstringpath, requiredThe environment's id.
regionIdstringpath, requiredThe region's id.
localeIdstringpath, requiredThe language's id.
contentIdstringpath, requiredThe content item'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.
Responses
201Created{ token, expiresAt, url }.dataobjectFields of data
tokenstringexpiresAtstringIn an hour.
urlstringThe space's preview address with the token, ready to open.
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 content:read_draft, 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 content item, 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/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21/preview' \ -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": { "token": "cms_pk_…", "expiresAt": "2026-11-02T09:30:00.000Z", "url": "https://northwilds.com/trips/lofoten-sea-kayaking" }}Erases an item in the bin, with its history, for good
DELETE/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}/purgeKey required
Erases an item in the bin, with its history, for good. Permission: content:purge.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
environmentIdstringpath, requiredThe environment's id.
regionIdstringpath, requiredThe region's id.
localeIdstringpath, requiredThe language's id.
contentIdstringpath, requiredThe content item's id.
Responses
204No contentDone, nothing to return.400Bad requestIt 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 content:purge, 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 content item, 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/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21/purge' \ -H 'Authorization: Bearer cms_mt_…'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Takes it out of the bin, as an unpublished draft
POST/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}/restoreKey required
Takes it out of the bin, as an unpublished draft. Permission: content:create.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
environmentIdstringpath, requiredThe environment's id.
regionIdstringpath, requiredThe region's id.
localeIdstringpath, requiredThe language's id.
contentIdstringpath, requiredThe content item'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.
Responses
200OKThe item.dataContentOne piece of content with its draft.
Fields of data
idstringAn id.
namestringslugstringurlstring or null
One of draft, in_review, published, scheduled, archived.statusstringcontentTypeKeystringfolderIdstring or nullAn id.
externalIdstring or nullisGlobalbooleanisFolderIndexbooleanupdatedAtstringpublishedAtstring or nullurlOverridestring or nulldraftobjectThe draft. No seo for content without an address.
Fields of draft
fieldsmap of anyField values by key. See https://docs.bifrostorbit.com/cms/developers/field-types/.
componentsBlock[]seoobjectsometimesFields of seo
titlestring or nulldescriptionstring or nullcanonicalstring or nullnoIndexbooleanogTitlestring or nullogDescriptionstring or nullogImagestring or nullA media id or address.
twitterTitlestring or nulltwitterDescriptionstring or nulltwitterImagestring or nullnoFollowbooleanbreadcrumbLabelstring or nullsitemapExcludeboolean
One of always, hourly, daily, weekly, monthly, yearly, never.sitemapChangeFrequencystring or null
At least 0. At most 1.sitemapPrioritynumber or null
updatedAtstringupdatedBystringAn id.
draftVersionintegerpublishedVersionintegerCompare with draftVersion to see whether the draft has unpublished changes.
docVersionintegerSend it back with each save, so a save never overwrites changes you haven't seen.
400Bad requestIt isn't in the bin, or its folder is gone.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 content:create, 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 content item, 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/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21/restore' \ -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": "6650f1c2a9e4b1d2c3f40a21", "name": "Lofoten sea kayaking", "slug": "lofoten-sea-kayaking", "url": "/trips/lofoten-sea-kayaking", "status": "draft", "contentTypeKey": "trip", "folderId": "6650f1c2a9e4b1d2c3f40a20", "externalId": null, "isGlobal": false, "isFolderIndex": false, "updatedAt": "2026-11-02T09:30:00.000Z", "publishedAt": "2026-11-02T09:30:00.000Z", "urlOverride": null, "draft": { "fields": {}, "components": [ { "id": "hero-1", "type": "hero", "schemaVersion": 12, "fields": { "heading": "Paddle the Lofoten fjords" }, "children": {}, "variant": null } ], "seo": { "title": "Lofoten sea kayaking", "description": "Six days of paddling between the peaks of Lofoten.", "canonical": null, "noIndex": false, "ogTitle": null, "ogDescription": null, "ogImage": null, "twitterTitle": null, "twitterDescription": null, "twitterImage": null, "noFollow": false, "breadcrumbLabel": null, "sitemapExclude": false, "sitemapChangeFrequency": "always", "sitemapPriority": 0 }, "updatedAt": "2026-11-02T09:30:00.000Z", "updatedBy": "6650f1c2a9e4b1d2c3f40a30" }, "draftVersion": 12, "publishedVersion": 12, "docVersion": 12 }}Its saved and published versions, newest first, within the plan's history
GET/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}/revisionsKey required
Its saved and published versions, newest first, within the plan's history. Permission: content:read.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
environmentIdstringpath, requiredThe environment's id.
regionIdstringpath, requiredThe region's id.
localeIdstringpath, requiredThe language's id.
contentIdstringpath, requiredThe content item's id.
Responses
200OK[{ id, version, kind, changeSummary, rollbackOfVersion, userId, by, createdAt }].dataobject[]Newest first, within the plan's history.
Fields of data
idstringAn id.
versioninteger
One of save, publish, unpublish, rollback, release, promotion.kindstringchangeSummarystring or nullrollbackOfVersioninteger or nulluserIdstringAn id.
bystring or nullWho, by name.
createdAtstring
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 content: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 content item, 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/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21/revisions' \ -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", "version": 12, "kind": "save", "changeSummary": null, "rollbackOfVersion": 12, "userId": "6650f1c2a9e4b1d2c3f40a30", "by": "Ingrid Berg", "createdAt": "2026-11-02T09:30:00.000Z" } ]}What changed between a revision and the draft
GET/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}/revisions/{revisionId}/compareKey required
What changed between a revision and the draft. Permission: content:read_draft.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
environmentIdstringpath, requiredThe environment's id.
regionIdstringpath, requiredThe region's id.
localeIdstringpath, requiredThe language's id.
contentIdstringpath, requiredThe content item's id.
revisionIdstringpath, requiredThe revision's id.
Responses
200OK{ version, createdAt, changes, before }.dataobjectFields of data
versionintegercreatedAtstringchangesobject[]What differs between the revision and the draft.
Fields of changes
One of field, seo, component.areastringkeystringtypestringsometimes
One of added, removed, changed.changestringfieldsstring[]sometimeslabelstringSuch as Title, or Hero › Heading.
beforeobjectThe revision's fields and blocks.
Fields of before
fieldsmap of anycomponentsBlock[]
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 content:read_draft.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 revision, 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/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21/revisions/6650f1c2a9e4b1d2c3f40a30/compare' \ -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": { "version": 12, "createdAt": "2026-11-02T09:30:00.000Z", "changes": [ { "area": "field", "key": "lofoten", "type": "…", "change": "added", "fields": [ "…" ], "label": "Kayaking" } ], "before": { "fields": {}, "components": [ { "id": "hero-1", "type": "hero", "schemaVersion": 12, "fields": { "heading": "Paddle the Lofoten fjords" }, "children": {}, "variant": null } ] } }}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.
Block
One block in a page body.
idstringtypestringThe component's key, such as hero.
schemaVersionintegerfieldsmap of anyThe component's fields.
childrenmap of Block[]Further blocks by slot.
Fields of children
idstringtypestringThe component's key, such as hero.
schemaVersionintegerfieldsmap of anyThe component's fields.
childrenmap of Block[]Further blocks by slot.
Fields of children
idstringtypestringThe component's key, such as hero.
schemaVersionintegerfieldsmap of anyThe component's fields.
childrenmap of Block[]Further blocks by slot.
Fields of children
idstringtypestringThe component's key, such as hero.
schemaVersionintegerfieldsmap of anyThe component's fields.
childrenmap of Block[]Further blocks by slot.
variantstring or null
variantstring or null
variantstring or null
variantstring or null
ContentSummary
idstringAn id.
namestringslugstringurlstring or nullSuch as /trips/lofoten-sea-kayaking. null for content without an address.
statusstringpublished once it has been published, even while the draft has changes.
One of draft, in_review, published, scheduled, archived.contentTypeKeystringfolderIdstring or nullAn id.
externalIdstring or nullYour own id for the entry, such as its id in the system it was imported from. Unique in its language.
isGlobalbooleanisFolderIndexbooleanupdatedAtstringpublishedAtstring or null
Content
One piece of content with its draft.
idstringAn id.
namestringslugstringurlstring or null
One of draft, in_review, published, scheduled, archived.statusstringcontentTypeKeystringfolderIdstring or nullAn id.
externalIdstring or nullisGlobalbooleanisFolderIndexbooleanupdatedAtstringpublishedAtstring or nullurlOverridestring or nulldraftobjectThe draft. No seo for content without an address.
Fields of draft
fieldsmap of anyField values by key. See https://docs.bifrostorbit.com/cms/developers/field-types/.
componentsBlock[]seoobjectsometimesFields of seo
titlestring or nulldescriptionstring or nullcanonicalstring or nullnoIndexbooleanogTitlestring or nullogDescriptionstring or nullogImagestring or nullA media id or address.
twitterTitlestring or nulltwitterDescriptionstring or nulltwitterImagestring or nullnoFollowbooleanbreadcrumbLabelstring or nullsitemapExcludeboolean
One of always, hourly, daily, weekly, monthly, yearly, never.sitemapChangeFrequencystring or null
At least 0. At most 1.sitemapPrioritynumber or null
updatedAtstringupdatedBystringAn id.
draftVersionintegerpublishedVersionintegerCompare with draftVersion to see whether the draft has unpublished changes.
docVersionintegerSend it back with each save, so a save never overwrites changes you haven't seen.