Content types and components
Content types and components in the management API. 14 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.
Every component (block type)
GET/organisations/{organisationId}/spaces/{spaceId}/componentsKey required
Every component (block type). Permission: schema:read.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
Responses
200OKList.dataComponent[]Fields of data
idstringAn id.
keystringSuch as hero.
namestringdescriptionstring or nulliconstring or nullgroupstring or nullfieldsField[]allowedChildrenstring[] or "*"Blocks its slots may hold, or * for any.
isRootbooleanMay sit at the top of a page.
isNestablebooleanMay sit inside another block.
previewImagestring or nullmainHeadingstring or nullThe text field that is the page's main heading when the block is used.
mainHeadingWhenstring or nullA yes/no field that decides whether mainHeading counts.
hiddenFromLibrarybooleanLeft out of the block library editors pick from.
schemaVersionintegerdeprecatedbooleanupdatedAtstring
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: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/components' \ -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": "6650f1c2a9e4b1d2c3f40a49", "key": "hero", "name": "Hero", "description": "Six days of paddling between the peaks of Lofoten.", "icon": null, "group": "Page top", "fields": [ { "key": "title", "name": "Title", "type": "text", "description": "Six days of paddling between the peaks of Lofoten.", "required": true, "default": null, "validation": { "min": 1, "max": 1, "minLength": 1, "maxLength": 1, "pattern": "…", "message": "…" }, "options": [ { "label": "Kayaking", "value": "…" } ], "allowedComponents": [ "…" ], "allowedContentTypes": [ "…" ], "allowedMimeTypes": [ "…" ], "taxonomyKey": "…", "localised": false, "regional": false, "protects": "none", "group": "…", "hidden": false, "showWhen": { "field": "…", "equals": null }, "step": 1, "unit": "…", "halfStars": false, "languages": [ "text" ], "defaultLanguage": "text" } ], "allowedChildren": [ "…" ], "isRoot": true, "isNestable": true, "previewImage": null, "mainHeading": null, "mainHeadingWhen": null, "hiddenFromLibrary": false, "schemaVersion": 12, "deprecated": false, "updatedAt": "2026-11-02T09:30:00.000Z" } ]}Adds one
POST/organisations/{organisationId}/spaces/{spaceId}/componentsKey required
Adds one. 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
keystringrequiredSuch as hero. Never changes.
Up to 64 characters.
Up to 200 characters.namestringrequired
Up to 500 characters.descriptionstring or nulloptional
Up to 60 characters.iconstring or nulloptional
Up to 60 characters.groupstring or nulloptionalfieldsobject[]optionalThe fields. See the Field schema and the field types guide.
Fields of fields
Up to 64 characters.keystringrequired
Up to 200 characters.namestringrequired
One of text, textarea, richtext, number, boolean, select, multiselect, color, slider, rating, code, palette, date, time, datetime, asset, assets, link, targets, reference, references, taxonomy, taxonomyTerms, claims, component, components, trip, trips, destination, departure, product, products, collection, bookingService, bookingServices, bookingStaff, reviewLocation, job, jobFilter, shopifyProduct, shopifyProducts.typestringrequired
Up to 300 characters.descriptionstringoptional
Default false.requiredbooleanoptionaldefaultanyoptionalAny JSON value.
validationobjectoptionalFields of validation
minnumberoptionalmaxnumberoptional
At least 0.minLengthintegeroptional
At least 1.maxLengthintegeroptional
Up to 200 characters.patternstringoptional
Up to 200 characters.messagestringoptional
optionsobject[]optionalFields of options
Up to 120 characters.labelstringrequired
Up to 120 characters.valuestringrequired
allowedComponentsstring[]optionalallowedContentTypesstring[]optionalallowedMimeTypesstring[]optional
Up to 64 characters.taxonomyKeystringoptionallocalisedbooleanoptionalregionalbooleanoptional
One of none, price, promotion.protectsstringoptional
Up to 60 characters.groupstringoptionalhiddenbooleanoptionalshowWhenobjectoptionalFields of showWhen
Up to 64 characters.fieldstringrequiredequalsboolean or string or string[]required
stepnumberoptional
Up to 20 characters.unitstringoptionalhalfStarsbooleanoptional
Up to 22 items.languagesstring[]optional
One of text, ts, tsx, js, json, html, xml, yaml, graphql, bash, python, php, java, kotlin, swift, vue, svelte, astro, blade, twig, dockerfile, http.defaultLanguagestringoptional
allowedChildren"*" or string[]optional* or the keys of blocks its slots may hold.
Default [].isRootbooleanoptionalMay sit at the top of a page.
Default true.isNestablebooleanoptionalMay sit inside another block.
Default true.
Up to 500 characters.previewImagestring or nulloptional
Up to 64 characters.mainHeadingstring or nulloptional
Up to 64 characters.mainHeadingWhenstring or nulloptionalhiddenFromLibrarybooleanoptional
Responses
201CreatedThe new item.dataComponentFields of data
idstringAn id.
keystringSuch as hero.
namestringdescriptionstring or nulliconstring or nullgroupstring or nullfieldsField[]allowedChildrenstring[] or "*"Blocks its slots may hold, or * for any.
isRootbooleanMay sit at the top of a page.
isNestablebooleanMay sit inside another block.
previewImagestring or nullmainHeadingstring or nullThe text field that is the page's main heading when the block is used.
mainHeadingWhenstring or nullA yes/no field that decides whether mainHeading counts.
hiddenFromLibrarybooleanLeft out of the block library editors pick from.
schemaVersionintegerdeprecatedbooleanupdatedAtstring
400Bad requestThe body isn't valid JSON. Or a field nests components in a way that loops, or a main heading that isn't a text field.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.
409ConflictA component with the key 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/components' \ -H 'Authorization: Bearer cms_mt_…' \ -H 'Content-Type: application/json' \ -d '{"key":"tripHighlights","name":"Trip highlights","group":"Trips","fields":[{"key":"heading","name":"Heading","type":"text","required":true},{"key":"items","name":"Highlights","type":"textarea"}]}'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": { "id": "6650f1c2a9e4b1d2c3f40a49", "key": "hero", "name": "Hero", "description": "Six days of paddling between the peaks of Lofoten.", "icon": null, "group": "Page top", "fields": [ { "key": "title", "name": "Title", "type": "text", "description": "Six days of paddling between the peaks of Lofoten.", "required": true, "default": null, "validation": { "min": 1, "max": 1, "minLength": 1, "maxLength": 1, "pattern": "…", "message": "…" }, "options": [ { "label": "Kayaking", "value": "…" } ], "allowedComponents": [ "…" ], "allowedContentTypes": [ "…" ], "allowedMimeTypes": [ "…" ], "taxonomyKey": "…", "localised": false, "regional": false, "protects": "none", "group": "…", "hidden": false, "showWhen": { "field": "…", "equals": null }, "step": 1, "unit": "…", "halfStars": false, "languages": [ "text" ], "defaultLanguage": "text" } ], "allowedChildren": [ "…" ], "isRoot": true, "isNestable": true, "previewImage": null, "mainHeading": null, "mainHeadingWhen": null, "hiddenFromLibrary": false, "schemaVersion": 12, "deprecated": false, "updatedAt": "2026-11-02T09:30:00.000Z" }}Deletes one no page or component uses
DELETE/organisations/{organisationId}/spaces/{spaceId}/components/{key}Key required
Deletes one no page or component uses. Permission: schema:manage.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
keystringpath, requiredThe key, such as trip, hero or activity.
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 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 item with that key, 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.
409ConflictPages or other components still use it.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/components/trip' \ -H 'Authorization: Bearer cms_mt_…'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
One component
GET/organisations/{organisationId}/spaces/{spaceId}/components/{key}Key required
One component. Permission: schema:read.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
keystringpath, requiredThe key, such as trip, hero or activity.
Responses
200OKThe component.dataComponentFields of data
idstringAn id.
keystringSuch as hero.
namestringdescriptionstring or nulliconstring or nullgroupstring or nullfieldsField[]allowedChildrenstring[] or "*"Blocks its slots may hold, or * for any.
isRootbooleanMay sit at the top of a page.
isNestablebooleanMay sit inside another block.
previewImagestring or nullmainHeadingstring or nullThe text field that is the page's main heading when the block is used.
mainHeadingWhenstring or nullA yes/no field that decides whether mainHeading counts.
hiddenFromLibrarybooleanLeft out of the block library editors pick from.
schemaVersionintegerdeprecatedbooleanupdatedAtstring
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: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 item with that key, 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/components/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": { "id": "6650f1c2a9e4b1d2c3f40a49", "key": "hero", "name": "Hero", "description": "Six days of paddling between the peaks of Lofoten.", "icon": null, "group": "Page top", "fields": [ { "key": "title", "name": "Title", "type": "text", "description": "Six days of paddling between the peaks of Lofoten.", "required": true, "default": null, "validation": { "min": 1, "max": 1, "minLength": 1, "maxLength": 1, "pattern": "…", "message": "…" }, "options": [ { "label": "Kayaking", "value": "…" } ], "allowedComponents": [ "…" ], "allowedContentTypes": [ "…" ], "allowedMimeTypes": [ "…" ], "taxonomyKey": "…", "localised": false, "regional": false, "protects": "none", "group": "…", "hidden": false, "showWhen": { "field": "…", "equals": null }, "step": 1, "unit": "…", "halfStars": false, "languages": [ "text" ], "defaultLanguage": "text" } ], "allowedChildren": [ "…" ], "isRoot": true, "isNestable": true, "previewImage": null, "mainHeading": null, "mainHeadingWhen": null, "hiddenFromLibrary": false, "schemaVersion": 12, "deprecated": false, "updatedAt": "2026-11-02T09:30:00.000Z" }}Changes one, or marks it deprecated
PATCH/organisations/{organisationId}/spaces/{spaceId}/components/{key}Key required
Changes one, or marks it deprecated. Permission: schema:manage.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
keystringpath, requiredThe key, such as trip, hero or activity.
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 500 characters.descriptionstring or nulloptional
Up to 60 characters.iconstring or nulloptional
Up to 60 characters.groupstring or nulloptionalfieldsobject[]optionalFields of fields
Up to 64 characters.keystringrequired
Up to 200 characters.namestringrequired
One of text, textarea, richtext, number, boolean, select, multiselect, color, slider, rating, code, palette, date, time, datetime, asset, assets, link, targets, reference, references, taxonomy, taxonomyTerms, claims, component, components, trip, trips, destination, departure, product, products, collection, bookingService, bookingServices, bookingStaff, reviewLocation, job, jobFilter, shopifyProduct, shopifyProducts.typestringrequired
Up to 300 characters.descriptionstringoptional
Default false.requiredbooleanoptionaldefaultanyoptionalAny JSON value.
validationobjectoptionalFields of validation
minnumberoptionalmaxnumberoptional
At least 0.minLengthintegeroptional
At least 1.maxLengthintegeroptional
Up to 200 characters.patternstringoptional
Up to 200 characters.messagestringoptional
optionsobject[]optionalFields of options
Up to 120 characters.labelstringrequired
Up to 120 characters.valuestringrequired
allowedComponentsstring[]optionalallowedContentTypesstring[]optionalallowedMimeTypesstring[]optional
Up to 64 characters.taxonomyKeystringoptionallocalisedbooleanoptionalregionalbooleanoptional
One of none, price, promotion.protectsstringoptional
Up to 60 characters.groupstringoptionalhiddenbooleanoptionalshowWhenobjectoptionalFields of showWhen
Up to 64 characters.fieldstringrequiredequalsboolean or string or string[]required
stepnumberoptional
Up to 20 characters.unitstringoptionalhalfStarsbooleanoptional
Up to 22 items.languagesstring[]optional
One of text, ts, tsx, js, json, html, xml, yaml, graphql, bash, python, php, java, kotlin, swift, vue, svelte, astro, blade, twig, dockerfile, http.defaultLanguagestringoptional
allowedChildren"*" or string[]optionalisRootbooleanoptionalisNestablebooleanoptional
Up to 500 characters.previewImagestring or nulloptionaldeprecatedbooleanoptional
Up to 64 characters.mainHeadingstring or nulloptional
Up to 64 characters.mainHeadingWhenstring or nulloptionalhiddenFromLibrarybooleanoptional
Responses
200OKThe component.dataComponentFields of data
idstringAn id.
keystringSuch as hero.
namestringdescriptionstring or nulliconstring or nullgroupstring or nullfieldsField[]allowedChildrenstring[] or "*"Blocks its slots may hold, or * for any.
isRootbooleanMay sit at the top of a page.
isNestablebooleanMay sit inside another block.
previewImagestring or nullmainHeadingstring or nullThe text field that is the page's main heading when the block is used.
mainHeadingWhenstring or nullA yes/no field that decides whether mainHeading counts.
hiddenFromLibrarybooleanLeft out of the block library editors pick from.
schemaVersionintegerdeprecatedbooleanupdatedAtstring
400Bad requestThe body isn't valid JSON. Or a field nests components in a way that loops, or a main heading that isn't a text field.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 item with that key, 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/components/trip' \ -H 'Authorization: Bearer cms_mt_…' \ -H 'Content-Type: application/json' \ -d '{"name":"Trip highlights","deprecated":false}'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": { "id": "6650f1c2a9e4b1d2c3f40a49", "key": "hero", "name": "Hero", "description": "Six days of paddling between the peaks of Lofoten.", "icon": null, "group": "Page top", "fields": [ { "key": "title", "name": "Title", "type": "text", "description": "Six days of paddling between the peaks of Lofoten.", "required": true, "default": null, "validation": { "min": 1, "max": 1, "minLength": 1, "maxLength": 1, "pattern": "…", "message": "…" }, "options": [ { "label": "Kayaking", "value": "…" } ], "allowedComponents": [ "…" ], "allowedContentTypes": [ "…" ], "allowedMimeTypes": [ "…" ], "taxonomyKey": "…", "localised": false, "regional": false, "protects": "none", "group": "…", "hidden": false, "showWhen": { "field": "…", "equals": null }, "step": 1, "unit": "…", "halfStars": false, "languages": [ "text" ], "defaultLanguage": "text" } ], "allowedChildren": [ "…" ], "isRoot": true, "isNestable": true, "previewImage": null, "mainHeading": null, "mainHeadingWhen": null, "hiddenFromLibrary": false, "schemaVersion": 12, "deprecated": false, "updatedAt": "2026-11-02T09:30:00.000Z" }}Locks it, or asks for brand sign-off: { locked, brandApproval }
PUT/organisations/{organisationId}/spaces/{spaceId}/components/{key}/brandKey required
Locks it, or asks for brand sign-off: { locked, brandApproval }. Permission: brand:manage.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
keystringpath, requiredThe key, such as trip, hero or activity.
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
lockedbooleanoptionalOnly people with brand:manage can change its fields.
brandApprovalbooleanoptionalChanges need brand sign-off before publishing.
Responses
200OK{ locked, brandApproval }.dataobjectFields of data
lockedbooleanbrandApprovalboolean
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 brand: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 item with that key, 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 PUT 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/components/trip/brand' \ -H 'Authorization: Bearer cms_mt_…' \ -H 'Content-Type: application/json' \ -d '{"locked":true,"brandApproval":true}'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": { "locked": false, "brandApproval": false }}Every content type
GET/organisations/{organisationId}/spaces/{spaceId}/content-typesKey required
Every content type. Permission: schema:read.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
Responses
200OKList.dataContentType[]Fields of data
idstringAn id.
keystringSuch as trip.
namestringdescriptionstring or nulliconstring or nullgroupstring or nullfieldsField[]allowedComponentsstring[] or "*"Blocks the body may hold, or * for any.
templatestring[]Blocks a new item starts with.
seoobjectFields of seo
enabledbooleanfieldsField[]titleTemplatestring or nullsometimesdescriptionFieldstring or nullsometimessitemapPrioritynumber or nullsometimessitemapChangeFrequencystring or nullsometimesnoIndexByDefaultbooleansometimes
slugBehaviourobjectFields of slugBehaviour
One of name, manual.sourcestringeditablebooleanuniqueboolean
publishingobjectFields of publishing
requiresApprovalbooleanstepsobject[]sometimesUp to 5 approval steps.
Fields of steps
keystringnamestringrolestring or nullsometimespermissionstring or nullsometimes
regionStepsmap of object[]sometimesApproval steps for one region, by region key.
Fields of regionSteps
keystringnamestringrolestring or nullsometimespermissionstring or nullsometimes
reviewMonthsinteger or nullsometimesMonths until an item is due for review.
isGlobalbooleanRead by key, with no address, such as a footer.
singletonbooleanOnly one item of this type.
urlPrefixstring or nullWhere items of this type live, such as /trips.
One of preview, panel.editorstring or nullmainHeadingstring or nullThe text field that is the item's main heading.
schemaVersionintegerGoes up each time the fields change.
updatedAtstring
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: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/content-types' \ -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": "6650f1c2a9e4b1d2c3f40a4b", "key": "trip", "name": "Trip", "description": "A trip with its departures.", "icon": null, "group": null, "fields": [ { "key": "title", "name": "Title", "type": "text", "description": "Six days of paddling between the peaks of Lofoten.", "required": true, "default": null, "validation": { "min": 1, "max": 1, "minLength": 1, "maxLength": 1, "pattern": "…", "message": "…" }, "options": [ { "label": "Kayaking", "value": "…" } ], "allowedComponents": [ "…" ], "allowedContentTypes": [ "…" ], "allowedMimeTypes": [ "…" ], "taxonomyKey": "…", "localised": false, "regional": false, "protects": "none", "group": "…", "hidden": false, "showWhen": { "field": "…", "equals": null }, "step": 1, "unit": "…", "halfStars": false, "languages": [ "text" ], "defaultLanguage": "text" } ], "allowedComponents": [ "…" ], "template": [ "…" ], "seo": { "enabled": true, "fields": [ { "key": "title", "name": "Title", "type": "text", "description": "Six days of paddling between the peaks of Lofoten.", "required": true, "default": null, "validation": { "min": 1, "max": 1, "minLength": 1, "maxLength": 1, "pattern": "…", "message": "…" }, "options": [ { "label": "Kayaking", "value": "…" } ], "allowedComponents": [ "…" ], "allowedContentTypes": [ "…" ], "allowedMimeTypes": [ "…" ], "taxonomyKey": "…", "localised": false, "regional": false, "protects": "none", "group": "…", "hidden": false, "showWhen": { "field": "…", "equals": null }, "step": 1, "unit": "…", "halfStars": false, "languages": [ "text" ], "defaultLanguage": "text" } ], "titleTemplate": null, "descriptionField": null, "sitemapPriority": 1, "sitemapChangeFrequency": null, "noIndexByDefault": false }, "slugBehaviour": { "source": "name", "editable": true, "unique": true }, "publishing": { "requiresApproval": false, "steps": [ { "key": "lofoten", "name": "Lofoten sea kayaking", "role": null, "permission": null } ], "regionSteps": {}, "reviewMonths": 1 }, "isGlobal": false, "singleton": false, "urlPrefix": null, "editor": "preview", "mainHeading": null, "schemaVersion": 12, "updatedAt": "2026-11-02T09:30:00.000Z" } ]}Adds one
POST/organisations/{organisationId}/spaces/{spaceId}/content-typesKey required
Adds one. 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
keystringrequiredSuch as trip. Never changes.
Up to 64 characters.
Up to 200 characters.namestringrequired
Up to 500 characters.descriptionstring or nulloptional
Up to 60 characters.iconstring or nulloptional
Up to 60 characters.groupstring or nulloptionalfieldsobject[]optionalThe fields. See the Field schema and the field types guide.
Fields of fields
Up to 64 characters.keystringrequired
Up to 200 characters.namestringrequired
One of text, textarea, richtext, number, boolean, select, multiselect, color, slider, rating, code, palette, date, time, datetime, asset, assets, link, targets, reference, references, taxonomy, taxonomyTerms, claims, component, components, trip, trips, destination, departure, product, products, collection, bookingService, bookingServices, bookingStaff, reviewLocation, job, jobFilter, shopifyProduct, shopifyProducts.typestringrequired
Up to 300 characters.descriptionstringoptional
Default false.requiredbooleanoptionaldefaultanyoptionalAny JSON value.
validationobjectoptionalFields of validation
minnumberoptionalmaxnumberoptional
At least 0.minLengthintegeroptional
At least 1.maxLengthintegeroptional
Up to 200 characters.patternstringoptional
Up to 200 characters.messagestringoptional
optionsobject[]optionalFields of options
Up to 120 characters.labelstringrequired
Up to 120 characters.valuestringrequired
allowedComponentsstring[]optionalallowedContentTypesstring[]optionalallowedMimeTypesstring[]optional
Up to 64 characters.taxonomyKeystringoptionallocalisedbooleanoptionalregionalbooleanoptional
One of none, price, promotion.protectsstringoptional
Up to 60 characters.groupstringoptionalhiddenbooleanoptionalshowWhenobjectoptionalFields of showWhen
Up to 64 characters.fieldstringrequiredequalsboolean or string or string[]required
stepnumberoptional
Up to 20 characters.unitstringoptionalhalfStarsbooleanoptional
Up to 22 items.languagesstring[]optional
One of text, ts, tsx, js, json, html, xml, yaml, graphql, bash, python, php, java, kotlin, swift, vue, svelte, astro, blade, twig, dockerfile, http.defaultLanguagestringoptional
allowedComponents"*" or string[]optional* or the keys of blocks the body may hold.
Default "*".templatestring[]optionalBlocks a new item starts with.
Default [].seoobjectoptionalFields of seo
Default true.enabledbooleanoptionalfieldsobject[]optionalFields of fields
Up to 64 characters.keystringrequired
Up to 200 characters.namestringrequired
One of text, textarea, richtext, number, boolean, select, multiselect, color, slider, rating, code, palette, date, time, datetime, asset, assets, link, targets, reference, references, taxonomy, taxonomyTerms, claims, component, components, trip, trips, destination, departure, product, products, collection, bookingService, bookingServices, bookingStaff, reviewLocation, job, jobFilter, shopifyProduct, shopifyProducts.typestringrequired
Up to 300 characters.descriptionstringoptional
Default false.requiredbooleanoptionaldefaultanyoptionalAny JSON value.
validationobjectoptionalFields of validation
minnumberoptionalmaxnumberoptional
At least 0.minLengthintegeroptional
At least 1.maxLengthintegeroptional
Up to 200 characters.patternstringoptional
Up to 200 characters.messagestringoptional
optionsobject[]optionalFields of options
Up to 120 characters.labelstringrequired
Up to 120 characters.valuestringrequired
allowedComponentsstring[]optionalallowedContentTypesstring[]optionalallowedMimeTypesstring[]optional
Up to 64 characters.taxonomyKeystringoptionallocalisedbooleanoptionalregionalbooleanoptional
One of none, price, promotion.protectsstringoptional
Up to 60 characters.groupstringoptionalhiddenbooleanoptionalshowWhenobjectoptionalFields of showWhen
Up to 64 characters.fieldstringrequiredequalsboolean or string or string[]required
stepnumberoptional
Up to 20 characters.unitstringoptionalhalfStarsbooleanoptional
Up to 22 items.languagesstring[]optional
One of text, ts, tsx, js, json, html, xml, yaml, graphql, bash, python, php, java, kotlin, swift, vue, svelte, astro, blade, twig, dockerfile, http.defaultLanguagestringoptional
Up to 200 characters.titleTemplatestring or nulloptional
Up to 60 characters.descriptionFieldstring or nulloptional
At least 0. At most 1.sitemapPrioritynumber or nulloptional
One of always, hourly, daily, weekly, monthly, yearly, never.sitemapChangeFrequencystring or nulloptional
Default {"source":"name","editable":true,"unique":true}.slugBehaviourobjectoptionalFields of slugBehaviour
One of name, manual. Default "name".sourcestringoptional
Default true.editablebooleanoptional
Default true.uniquebooleanoptional
publishingobjectoptionalFields of publishing
Default false.requiresApprovalbooleanoptional
Up to 5 items.stepsobject[]optionalFields of steps
Up to 64 characters.keystringrequired
Up to 200 characters.namestringrequired
Up to 64 characters.rolestring or nulloptional
regionStepsmap of object[]optionalFields of regionSteps
Up to 64 characters.keystringrequired
Up to 200 characters.namestringrequired
Up to 64 characters.rolestring or nulloptional
At least 1. At most 36.reviewMonthsinteger or nulloptional
Default [].folderRestrictionsstring[]optionalisGlobalbooleanoptionalRead by key, with no address, such as a footer.
Default false.singletonbooleanoptionalOnly one item of this type.
Default false.
One of preview, panel.editorstringoptional
Up to 64 characters.mainHeadingstring or nulloptional
Responses
201CreatedThe new item.dataContentTypeFields of data
idstringAn id.
keystringSuch as trip.
namestringdescriptionstring or nulliconstring or nullgroupstring or nullfieldsField[]allowedComponentsstring[] or "*"Blocks the body may hold, or * for any.
templatestring[]Blocks a new item starts with.
seoobjectFields of seo
enabledbooleanfieldsField[]titleTemplatestring or nullsometimesdescriptionFieldstring or nullsometimessitemapPrioritynumber or nullsometimessitemapChangeFrequencystring or nullsometimesnoIndexByDefaultbooleansometimes
slugBehaviourobjectFields of slugBehaviour
One of name, manual.sourcestringeditablebooleanuniqueboolean
publishingobjectFields of publishing
requiresApprovalbooleanstepsobject[]sometimesUp to 5 approval steps.
Fields of steps
keystringnamestringrolestring or nullsometimespermissionstring or nullsometimes
regionStepsmap of object[]sometimesApproval steps for one region, by region key.
Fields of regionSteps
keystringnamestringrolestring or nullsometimespermissionstring or nullsometimes
reviewMonthsinteger or nullsometimesMonths until an item is due for review.
isGlobalbooleanRead by key, with no address, such as a footer.
singletonbooleanOnly one item of this type.
urlPrefixstring or nullWhere items of this type live, such as /trips.
One of preview, panel.editorstring or nullmainHeadingstring or nullThe text field that is the item's main heading.
schemaVersionintegerGoes up each time the fields change.
updatedAtstring
400Bad requestThe body isn't valid JSON. Or an editor or main heading the type can'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.
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 approval steps or review dates on a plan without them.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.
409ConflictA content type with the key 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/content-types' \ -H 'Authorization: Bearer cms_mt_…' \ -H 'Content-Type: application/json' \ -d '{"key":"trip","name":"Trip","fields":[{"key":"title","name":"Title","type":"text","required":true},{"key":"days","name":"Days","type":"number"}]}'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": { "id": "6650f1c2a9e4b1d2c3f40a4b", "key": "trip", "name": "Trip", "description": "A trip with its departures.", "icon": null, "group": null, "fields": [ { "key": "title", "name": "Title", "type": "text", "description": "Six days of paddling between the peaks of Lofoten.", "required": true, "default": null, "validation": { "min": 1, "max": 1, "minLength": 1, "maxLength": 1, "pattern": "…", "message": "…" }, "options": [ { "label": "Kayaking", "value": "…" } ], "allowedComponents": [ "…" ], "allowedContentTypes": [ "…" ], "allowedMimeTypes": [ "…" ], "taxonomyKey": "…", "localised": false, "regional": false, "protects": "none", "group": "…", "hidden": false, "showWhen": { "field": "…", "equals": null }, "step": 1, "unit": "…", "halfStars": false, "languages": [ "text" ], "defaultLanguage": "text" } ], "allowedComponents": [ "…" ], "template": [ "…" ], "seo": { "enabled": true, "fields": [ { "key": "title", "name": "Title", "type": "text", "description": "Six days of paddling between the peaks of Lofoten.", "required": true, "default": null, "validation": { "min": 1, "max": 1, "minLength": 1, "maxLength": 1, "pattern": "…", "message": "…" }, "options": [ { "label": "Kayaking", "value": "…" } ], "allowedComponents": [ "…" ], "allowedContentTypes": [ "…" ], "allowedMimeTypes": [ "…" ], "taxonomyKey": "…", "localised": false, "regional": false, "protects": "none", "group": "…", "hidden": false, "showWhen": { "field": "…", "equals": null }, "step": 1, "unit": "…", "halfStars": false, "languages": [ "text" ], "defaultLanguage": "text" } ], "titleTemplate": null, "descriptionField": null, "sitemapPriority": 1, "sitemapChangeFrequency": null, "noIndexByDefault": false }, "slugBehaviour": { "source": "name", "editable": true, "unique": true }, "publishing": { "requiresApproval": false, "steps": [ { "key": "lofoten", "name": "Lofoten sea kayaking", "role": null, "permission": null } ], "regionSteps": {}, "reviewMonths": 1 }, "isGlobal": false, "singleton": false, "urlPrefix": null, "editor": "preview", "mainHeading": null, "schemaVersion": 12, "updatedAt": "2026-11-02T09:30:00.000Z" }}Deletes one no content uses
DELETE/organisations/{organisationId}/spaces/{spaceId}/content-types/{key}Key required
Deletes one no content uses. Permission: schema:manage.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
keystringpath, requiredThe key, such as trip, hero or activity.
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 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 item with that key, 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.
409ConflictContent still uses it.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/content-types/trip' \ -H 'Authorization: Bearer cms_mt_…'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
One content type
GET/organisations/{organisationId}/spaces/{spaceId}/content-types/{key}Key required
One content type. Permission: schema:read.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
keystringpath, requiredThe key, such as trip, hero or activity.
Responses
200OKThe content type.dataContentTypeFields of data
idstringAn id.
keystringSuch as trip.
namestringdescriptionstring or nulliconstring or nullgroupstring or nullfieldsField[]allowedComponentsstring[] or "*"Blocks the body may hold, or * for any.
templatestring[]Blocks a new item starts with.
seoobjectFields of seo
enabledbooleanfieldsField[]titleTemplatestring or nullsometimesdescriptionFieldstring or nullsometimessitemapPrioritynumber or nullsometimessitemapChangeFrequencystring or nullsometimesnoIndexByDefaultbooleansometimes
slugBehaviourobjectFields of slugBehaviour
One of name, manual.sourcestringeditablebooleanuniqueboolean
publishingobjectFields of publishing
requiresApprovalbooleanstepsobject[]sometimesUp to 5 approval steps.
Fields of steps
keystringnamestringrolestring or nullsometimespermissionstring or nullsometimes
regionStepsmap of object[]sometimesApproval steps for one region, by region key.
Fields of regionSteps
keystringnamestringrolestring or nullsometimespermissionstring or nullsometimes
reviewMonthsinteger or nullsometimesMonths until an item is due for review.
isGlobalbooleanRead by key, with no address, such as a footer.
singletonbooleanOnly one item of this type.
urlPrefixstring or nullWhere items of this type live, such as /trips.
One of preview, panel.editorstring or nullmainHeadingstring or nullThe text field that is the item's main heading.
schemaVersionintegerGoes up each time the fields change.
updatedAtstring
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: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 item with that key, 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/content-types/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": { "id": "6650f1c2a9e4b1d2c3f40a4b", "key": "trip", "name": "Trip", "description": "A trip with its departures.", "icon": null, "group": null, "fields": [ { "key": "title", "name": "Title", "type": "text", "description": "Six days of paddling between the peaks of Lofoten.", "required": true, "default": null, "validation": { "min": 1, "max": 1, "minLength": 1, "maxLength": 1, "pattern": "…", "message": "…" }, "options": [ { "label": "Kayaking", "value": "…" } ], "allowedComponents": [ "…" ], "allowedContentTypes": [ "…" ], "allowedMimeTypes": [ "…" ], "taxonomyKey": "…", "localised": false, "regional": false, "protects": "none", "group": "…", "hidden": false, "showWhen": { "field": "…", "equals": null }, "step": 1, "unit": "…", "halfStars": false, "languages": [ "text" ], "defaultLanguage": "text" } ], "allowedComponents": [ "…" ], "template": [ "…" ], "seo": { "enabled": true, "fields": [ { "key": "title", "name": "Title", "type": "text", "description": "Six days of paddling between the peaks of Lofoten.", "required": true, "default": null, "validation": { "min": 1, "max": 1, "minLength": 1, "maxLength": 1, "pattern": "…", "message": "…" }, "options": [ { "label": "Kayaking", "value": "…" } ], "allowedComponents": [ "…" ], "allowedContentTypes": [ "…" ], "allowedMimeTypes": [ "…" ], "taxonomyKey": "…", "localised": false, "regional": false, "protects": "none", "group": "…", "hidden": false, "showWhen": { "field": "…", "equals": null }, "step": 1, "unit": "…", "halfStars": false, "languages": [ "text" ], "defaultLanguage": "text" } ], "titleTemplate": null, "descriptionField": null, "sitemapPriority": 1, "sitemapChangeFrequency": null, "noIndexByDefault": false }, "slugBehaviour": { "source": "name", "editable": true, "unique": true }, "publishing": { "requiresApproval": false, "steps": [ { "key": "lofoten", "name": "Lofoten sea kayaking", "role": null, "permission": null } ], "regionSteps": {}, "reviewMonths": 1 }, "isGlobal": false, "singleton": false, "urlPrefix": null, "editor": "preview", "mainHeading": null, "schemaVersion": 12, "updatedAt": "2026-11-02T09:30:00.000Z" }}Changes one
PATCH/organisations/{organisationId}/spaces/{spaceId}/content-types/{key}Key required
Changes one. Permission: schema:manage.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
keystringpath, requiredThe key, such as trip, hero or activity.
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.namestringoptionalurlPrefixstring or nulloptionalWhere items of this type live, such as /trips.
Up to 100 characters.
Up to 500 characters.descriptionstring or nulloptional
Up to 60 characters.iconstring or nulloptional
Up to 60 characters.groupstring or nulloptionalfieldsobject[]optionalFields of fields
Up to 64 characters.keystringrequired
Up to 200 characters.namestringrequired
One of text, textarea, richtext, number, boolean, select, multiselect, color, slider, rating, code, palette, date, time, datetime, asset, assets, link, targets, reference, references, taxonomy, taxonomyTerms, claims, component, components, trip, trips, destination, departure, product, products, collection, bookingService, bookingServices, bookingStaff, reviewLocation, job, jobFilter, shopifyProduct, shopifyProducts.typestringrequired
Up to 300 characters.descriptionstringoptional
Default false.requiredbooleanoptionaldefaultanyoptionalAny JSON value.
validationobjectoptionalFields of validation
minnumberoptionalmaxnumberoptional
At least 0.minLengthintegeroptional
At least 1.maxLengthintegeroptional
Up to 200 characters.patternstringoptional
Up to 200 characters.messagestringoptional
optionsobject[]optionalFields of options
Up to 120 characters.labelstringrequired
Up to 120 characters.valuestringrequired
allowedComponentsstring[]optionalallowedContentTypesstring[]optionalallowedMimeTypesstring[]optional
Up to 64 characters.taxonomyKeystringoptionallocalisedbooleanoptionalregionalbooleanoptional
One of none, price, promotion.protectsstringoptional
Up to 60 characters.groupstringoptionalhiddenbooleanoptionalshowWhenobjectoptionalFields of showWhen
Up to 64 characters.fieldstringrequiredequalsboolean or string or string[]required
stepnumberoptional
Up to 20 characters.unitstringoptionalhalfStarsbooleanoptional
Up to 22 items.languagesstring[]optional
One of text, ts, tsx, js, json, html, xml, yaml, graphql, bash, python, php, java, kotlin, swift, vue, svelte, astro, blade, twig, dockerfile, http.defaultLanguagestringoptional
allowedComponents"*" or string[]optionaltemplatestring[]optionalseoobjectoptionalFields of seo
enabledbooleanoptionalfieldsobject[]optionalFields of fields
Up to 64 characters.keystringrequired
Up to 200 characters.namestringrequired
One of text, textarea, richtext, number, boolean, select, multiselect, color, slider, rating, code, palette, date, time, datetime, asset, assets, link, targets, reference, references, taxonomy, taxonomyTerms, claims, component, components, trip, trips, destination, departure, product, products, collection, bookingService, bookingServices, bookingStaff, reviewLocation, job, jobFilter, shopifyProduct, shopifyProducts.typestringrequired
Up to 300 characters.descriptionstringoptional
Default false.requiredbooleanoptionaldefaultanyoptionalAny JSON value.
validationobjectoptionalFields of validation
minnumberoptionalmaxnumberoptional
At least 0.minLengthintegeroptional
At least 1.maxLengthintegeroptional
Up to 200 characters.patternstringoptional
Up to 200 characters.messagestringoptional
optionsobject[]optionalFields of options
Up to 120 characters.labelstringrequired
Up to 120 characters.valuestringrequired
allowedComponentsstring[]optionalallowedContentTypesstring[]optionalallowedMimeTypesstring[]optional
Up to 64 characters.taxonomyKeystringoptionallocalisedbooleanoptionalregionalbooleanoptional
One of none, price, promotion.protectsstringoptional
Up to 60 characters.groupstringoptionalhiddenbooleanoptionalshowWhenobjectoptionalFields of showWhen
Up to 64 characters.fieldstringrequiredequalsboolean or string or string[]required
stepnumberoptional
Up to 20 characters.unitstringoptionalhalfStarsbooleanoptional
Up to 22 items.languagesstring[]optional
One of text, ts, tsx, js, json, html, xml, yaml, graphql, bash, python, php, java, kotlin, swift, vue, svelte, astro, blade, twig, dockerfile, http.defaultLanguagestringoptional
Up to 200 characters.titleTemplatestring or nulloptional
Up to 60 characters.descriptionFieldstring or nulloptional
At least 0. At most 1.sitemapPrioritynumber or nulloptional
One of always, hourly, daily, weekly, monthly, yearly, never.sitemapChangeFrequencystring or nulloptional
slugBehaviourobjectoptionalFields of slugBehaviour
One of name, manual.sourcestringoptionaleditablebooleanoptionaluniquebooleanoptional
publishingobjectoptionalFields of publishing
Default false.requiresApprovalbooleanoptional
Up to 5 items.stepsobject[]optionalFields of steps
Up to 64 characters.keystringrequired
Up to 200 characters.namestringrequired
Up to 64 characters.rolestring or nulloptional
regionStepsmap of object[]optionalFields of regionSteps
Up to 64 characters.keystringrequired
Up to 200 characters.namestringrequired
Up to 64 characters.rolestring or nulloptional
At least 1. At most 36.reviewMonthsinteger or nulloptional
folderRestrictionsstring[]optionalisGlobalbooleanoptionalsingletonbooleanoptional
One of preview, panel.editorstringoptional
Up to 64 characters.mainHeadingstring or nulloptional
Responses
200OKThe content type.dataContentTypeFields of data
idstringAn id.
keystringSuch as trip.
namestringdescriptionstring or nulliconstring or nullgroupstring or nullfieldsField[]allowedComponentsstring[] or "*"Blocks the body may hold, or * for any.
templatestring[]Blocks a new item starts with.
seoobjectFields of seo
enabledbooleanfieldsField[]titleTemplatestring or nullsometimesdescriptionFieldstring or nullsometimessitemapPrioritynumber or nullsometimessitemapChangeFrequencystring or nullsometimesnoIndexByDefaultbooleansometimes
slugBehaviourobjectFields of slugBehaviour
One of name, manual.sourcestringeditablebooleanuniqueboolean
publishingobjectFields of publishing
requiresApprovalbooleanstepsobject[]sometimesUp to 5 approval steps.
Fields of steps
keystringnamestringrolestring or nullsometimespermissionstring or nullsometimes
regionStepsmap of object[]sometimesApproval steps for one region, by region key.
Fields of regionSteps
keystringnamestringrolestring or nullsometimespermissionstring or nullsometimes
reviewMonthsinteger or nullsometimesMonths until an item is due for review.
isGlobalbooleanRead by key, with no address, such as a footer.
singletonbooleanOnly one item of this type.
urlPrefixstring or nullWhere items of this type live, such as /trips.
One of preview, panel.editorstring or nullmainHeadingstring or nullThe text field that is the item's main heading.
schemaVersionintegerGoes up each time the fields change.
updatedAtstring
400Bad requestThe body isn't valid JSON. Or a urlPrefix that isn't valid, is used elsewhere or doesn't fit where items live, or an editor or main heading the type can'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.
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 item with that key, 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/content-types/trip' \ -H 'Authorization: Bearer cms_mt_…' \ -H 'Content-Type: application/json' \ -d '{"name":"Trip","urlPrefix":"/trips"}'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": { "id": "6650f1c2a9e4b1d2c3f40a4b", "key": "trip", "name": "Trip", "description": "A trip with its departures.", "icon": null, "group": null, "fields": [ { "key": "title", "name": "Title", "type": "text", "description": "Six days of paddling between the peaks of Lofoten.", "required": true, "default": null, "validation": { "min": 1, "max": 1, "minLength": 1, "maxLength": 1, "pattern": "…", "message": "…" }, "options": [ { "label": "Kayaking", "value": "…" } ], "allowedComponents": [ "…" ], "allowedContentTypes": [ "…" ], "allowedMimeTypes": [ "…" ], "taxonomyKey": "…", "localised": false, "regional": false, "protects": "none", "group": "…", "hidden": false, "showWhen": { "field": "…", "equals": null }, "step": 1, "unit": "…", "halfStars": false, "languages": [ "text" ], "defaultLanguage": "text" } ], "allowedComponents": [ "…" ], "template": [ "…" ], "seo": { "enabled": true, "fields": [ { "key": "title", "name": "Title", "type": "text", "description": "Six days of paddling between the peaks of Lofoten.", "required": true, "default": null, "validation": { "min": 1, "max": 1, "minLength": 1, "maxLength": 1, "pattern": "…", "message": "…" }, "options": [ { "label": "Kayaking", "value": "…" } ], "allowedComponents": [ "…" ], "allowedContentTypes": [ "…" ], "allowedMimeTypes": [ "…" ], "taxonomyKey": "…", "localised": false, "regional": false, "protects": "none", "group": "…", "hidden": false, "showWhen": { "field": "…", "equals": null }, "step": 1, "unit": "…", "halfStars": false, "languages": [ "text" ], "defaultLanguage": "text" } ], "titleTemplate": null, "descriptionField": null, "sitemapPriority": 1, "sitemapChangeFrequency": null, "noIndexByDefault": false }, "slugBehaviour": { "source": "name", "editable": true, "unique": true }, "publishing": { "requiresApproval": false, "steps": [ { "key": "lofoten", "name": "Lofoten sea kayaking", "role": null, "permission": null } ], "regionSteps": {}, "reviewMonths": 1 }, "isGlobal": false, "singleton": false, "urlPrefix": null, "editor": "preview", "mainHeading": null, "schemaVersion": 12, "updatedAt": "2026-11-02T09:30:00.000Z" }}Every content type and component at once, the field types, and whether you may change them
GET/organisations/{organisationId}/spaces/{spaceId}/schemaKey required
Every content type and component at once, the field types, and whether you may change them. Permission: schema:read.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
Responses
200OK{ contentTypes, components, fieldTypes, canManage }.dataobjectFields of data
contentTypesContentType[]componentsComponent[]fieldTypesobject[]Every field type this server knows.
Fields of fieldTypes
typestringSuch as text.
labelstringgroupstringSuch as text, choice, relation or structure.
supportsOptionsbooleansupportsComponentsbooleansupportsContentTypesbooleansupportsTaxonomyboolean
canManagebooleanYou may change the schema (schema:manage).
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: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/schema' \ -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": { "contentTypes": [ { "id": "6650f1c2a9e4b1d2c3f40a4b", "key": "trip", "name": "Trip", "description": "A trip with its departures.", "icon": null, "group": null, "fields": [ { "key": "title", "name": "Title", "type": "text", "description": "Six days of paddling between the peaks of Lofoten.", "required": true, "default": null, "validation": { "min": 1, "max": 1, "minLength": 1, "maxLength": 1, "pattern": "…", "message": "…" }, "options": [ { "label": "Kayaking", "value": "…" } ], "allowedComponents": [ "…" ], "allowedContentTypes": [ "…" ], "allowedMimeTypes": [ "…" ], "taxonomyKey": "…", "localised": false, "regional": false, "protects": "none", "group": "…", "hidden": false, "showWhen": { "field": "…", "equals": null }, "step": 1, "unit": "…", "halfStars": false, "languages": [ "text" ], "defaultLanguage": "text" } ], "allowedComponents": [ "…" ], "template": [ "…" ], "seo": { "enabled": true, "fields": [ { "key": "title", "name": "Title", "type": "text", "description": "Six days of paddling between the peaks of Lofoten.", "required": true, "default": null, "validation": { "min": 1, "max": 1, "minLength": 1, "maxLength": 1, "pattern": "…", "message": "…" }, "options": [ { "label": "Kayaking", "value": "…" } ], "allowedComponents": [ "…" ], "allowedContentTypes": [ "…" ], "allowedMimeTypes": [ "…" ], "taxonomyKey": "…", "localised": false, "regional": false, "protects": "none", "group": "…", "hidden": false, "showWhen": { "field": "…", "equals": null }, "step": 1, "unit": "…", "halfStars": false, "languages": [ "text" ], "defaultLanguage": "text" } ], "titleTemplate": null, "descriptionField": null, "sitemapPriority": 1, "sitemapChangeFrequency": null, "noIndexByDefault": false }, "slugBehaviour": { "source": "name", "editable": true, "unique": true }, "publishing": { "requiresApproval": false, "steps": [ { "key": "lofoten", "name": "Lofoten sea kayaking", "role": null, "permission": null } ], "regionSteps": {}, "reviewMonths": 1 }, "isGlobal": false, "singleton": false, "urlPrefix": null, "editor": "preview", "mainHeading": null, "schemaVersion": 12, "updatedAt": "2026-11-02T09:30:00.000Z" } ], "components": [ { "id": "6650f1c2a9e4b1d2c3f40a49", "key": "hero", "name": "Hero", "description": "Six days of paddling between the peaks of Lofoten.", "icon": null, "group": "Page top", "fields": [ { "key": "title", "name": "Title", "type": "text", "description": "Six days of paddling between the peaks of Lofoten.", "required": true, "default": null, "validation": { "min": 1, "max": 1, "minLength": 1, "maxLength": 1, "pattern": "…", "message": "…" }, "options": [ { "label": "Kayaking", "value": "…" } ], "allowedComponents": [ "…" ], "allowedContentTypes": [ "…" ], "allowedMimeTypes": [ "…" ], "taxonomyKey": "…", "localised": false, "regional": false, "protects": "none", "group": "…", "hidden": false, "showWhen": { "field": "…", "equals": null }, "step": 1, "unit": "…", "halfStars": false, "languages": [ "text" ], "defaultLanguage": "text" } ], "allowedChildren": [ "…" ], "isRoot": true, "isNestable": true, "previewImage": null, "mainHeading": null, "mainHeadingWhen": null, "hiddenFromLibrary": false, "schemaVersion": 12, "deprecated": false, "updatedAt": "2026-11-02T09:30:00.000Z" } ], "fieldTypes": [ { "type": "…", "label": "Kayaking", "group": "…", "supportsOptions": false, "supportsComponents": false, "supportsContentTypes": false, "supportsTaxonomy": false } ], "canManage": true }}How many entries use each content type and component, and hold a value in each of their fields
GET/organisations/{organisationId}/spaces/{spaceId}/schema/usesKey required
How many entries use each content type and component, and hold a value in each of their fields. Permission: schema:read.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
Responses
200OK{ contentTypes, components }.dataobjectFields of data
contentTypesmap of objectBy content type key. Types no entry uses are left out.
Fields of contentTypes
entriesintegerEntries of the type, in every environment, region and language, the bin left out.
fieldsmap of integerBy field key: entries holding a value in it, drafted or published.
componentsmap of objectBy component key. Components no entry uses are left out.
Fields of components
entriesintegerEntries with the block anywhere, drafted or published.
fieldsmap of integerBy field key: entries where the block holds a value in it.
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: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/schema/uses' \ -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": { "contentTypes": {}, "components": {} }}Pages that use a component, up to 24
GET/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/component-uses/{key}Key required
Pages that use a component, up to 24. 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.
keystringpath, requiredThe key, such as trip, hero or activity.
Responses
200OK[{ contentId, page, url, summary, node }].dataobject[]Up to 24 pages.
Fields of data
contentIdstringAn id.
pagestringThe page's name.
urlstring or nullsummarystring or nullThe block's main text.
nodeBlockOne block in a page body.
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 item with that key, 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/component-uses/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": [ { "contentId": "6650f1c2a9e4b1d2c3f40a21", "page": "…", "url": "https://northwilds.com/trips/lofoten-sea-kayaking", "summary": "Six days of paddling between the peaks of Lofoten.", "node": { "id": "6650f1c2a9e4b1d2c3f40a40", "type": "…", "schemaVersion": 12, "fields": {}, "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.
Field
keystringSuch as title.
namestringtypestringSuch as text, richtext, asset or reference. See https://docs.bifrostorbit.com/cms/developers/field-types/.
descriptionstringsometimesrequiredbooleandefaultanysometimesvalidationobjectsometimesFields of validation
minnumbersometimesmaxnumbersometimesminLengthintegersometimesmaxLengthintegersometimespatternstringsometimesmessagestringsometimes
optionsobject[]sometimesFields of options
labelstringvaluestring
allowedComponentsstring[]sometimesallowedContentTypesstring[]sometimesallowedMimeTypesstring[]sometimestaxonomyKeystringsometimeslocalisedbooleansometimesregionalbooleansometimes
One of none, price, promotion.protectsstringsometimesgroupstringsometimeshiddenbooleansometimesshowWhenobjectsometimesShow and check the field only while another field has this value.
Fields of showWhen
fieldstringequalsanyA value, true or false, or a list of values.
stepnumbersometimesSlider: how far one move goes, such as 0.5. 1 when left out.
unitstringsometimesSlider: a unit shown after the value, such as km or %. Up to 20 characters.
halfStarsbooleansometimesStar rating: allow half stars, such as 3.5.
languagesstring[]sometimesCode block: the languages editors may choose. Every language when left out or empty.
defaultLanguagestringsometimesCode block: the language a new block starts in. The first allowed language when left out.
One of text, ts, tsx, js, json, html, xml, yaml, graphql, bash, python, php, java, kotlin, swift, vue, svelte, astro, blade, twig, dockerfile, http.
ContentType
idstringAn id.
keystringSuch as trip.
namestringdescriptionstring or nulliconstring or nullgroupstring or nullfieldsField[]allowedComponentsstring[] or "*"Blocks the body may hold, or * for any.
templatestring[]Blocks a new item starts with.
seoobjectFields of seo
enabledbooleanfieldsField[]titleTemplatestring or nullsometimesdescriptionFieldstring or nullsometimessitemapPrioritynumber or nullsometimessitemapChangeFrequencystring or nullsometimesnoIndexByDefaultbooleansometimes
slugBehaviourobjectFields of slugBehaviour
One of name, manual.sourcestringeditablebooleanuniqueboolean
publishingobjectFields of publishing
requiresApprovalbooleanstepsobject[]sometimesUp to 5 approval steps.
Fields of steps
keystringnamestringrolestring or nullsometimespermissionstring or nullsometimes
regionStepsmap of object[]sometimesApproval steps for one region, by region key.
Fields of regionSteps
keystringnamestringrolestring or nullsometimespermissionstring or nullsometimes
reviewMonthsinteger or nullsometimesMonths until an item is due for review.
isGlobalbooleanRead by key, with no address, such as a footer.
singletonbooleanOnly one item of this type.
urlPrefixstring or nullWhere items of this type live, such as /trips.
One of preview, panel.editorstring or nullmainHeadingstring or nullThe text field that is the item's main heading.
schemaVersionintegerGoes up each time the fields change.
updatedAtstring
Component
idstringAn id.
keystringSuch as hero.
namestringdescriptionstring or nulliconstring or nullgroupstring or nullfieldsField[]allowedChildrenstring[] or "*"Blocks its slots may hold, or * for any.
isRootbooleanMay sit at the top of a page.
isNestablebooleanMay sit inside another block.
previewImagestring or nullmainHeadingstring or nullThe text field that is the page's main heading when the block is used.
mainHeadingWhenstring or nullA yes/no field that decides whether mainHeading counts.
hiddenFromLibrarybooleanLeft out of the block library editors pick from.
schemaVersionintegerdeprecatedbooleanupdatedAtstring
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