Skip to content

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, required

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

  • spaceIdstringpath, required

    The space's id.

Responses

  • 200OKList.
    • dataComponent[]

      Fields of data
      • idstring

        An id.

      • keystring

        Such as hero.

      • namestring

      • descriptionstring or null

      • iconstring or null

      • groupstring or null

      • fieldsField[]

        Fields of Field

      • allowedChildrenstring[] or "*"

        Blocks its slots may hold, or * for any.

      • isRootboolean

        May sit at the top of a page.

      • isNestableboolean

        May sit inside another block.

      • previewImagestring or null

      • mainHeadingstring or null

        The text field that is the page's main heading when the block is used.

      • mainHeadingWhenstring or null

        A yes/no field that decides whether mainHeading counts.

      • hiddenFromLibraryboolean

        Left out of the block library editors pick from.

      • schemaVersioninteger

      • deprecatedboolean

      • updatedAtstring

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

  • 403ForbiddenLacks schema:read.
    • errorobject

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

Shell
curl 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/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

200 OKJSON
{  "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, required

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

  • spaceIdstringpath, required

    The space's id.

  • Idempotency-Keystringheader

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

    Up to 255 characters.

Request body

  • keystringrequired

    Such as hero. Never changes.

    Up to 64 characters.
  • namestringrequired

    Up to 200 characters.
  • descriptionstring or nulloptional

    Up to 500 characters.
  • iconstring or nulloptional

    Up to 60 characters.
  • groupstring or nulloptional

    Up to 60 characters.
  • fieldsobject[]optional

    The fields. See the Field schema and the field types guide.

    Fields of fields
    • keystringrequired

      Up to 64 characters.
    • namestringrequired

      Up to 200 characters.
    • typestringrequired

      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.
    • descriptionstringoptional

      Up to 300 characters.
    • requiredbooleanoptional

      Default false.
    • defaultanyoptional

      Any JSON value.

    • validationobjectoptional

      Fields of validation
      • minnumberoptional

      • maxnumberoptional

      • minLengthintegeroptional

        At least 0.
      • maxLengthintegeroptional

        At least 1.
      • patternstringoptional

        Up to 200 characters.
      • messagestringoptional

        Up to 200 characters.
    • optionsobject[]optional

      Fields of options
      • labelstringrequired

        Up to 120 characters.
      • valuestringrequired

        Up to 120 characters.
    • allowedComponentsstring[]optional

    • allowedContentTypesstring[]optional

    • allowedMimeTypesstring[]optional

    • taxonomyKeystringoptional

      Up to 64 characters.
    • localisedbooleanoptional

    • regionalbooleanoptional

    • protectsstringoptional

      One of none, price, promotion.
    • groupstringoptional

      Up to 60 characters.
    • hiddenbooleanoptional

    • showWhenobjectoptional

      Fields of showWhen
      • fieldstringrequired

        Up to 64 characters.
      • equalsboolean or string or string[]required

    • stepnumberoptional

    • unitstringoptional

      Up to 20 characters.
    • halfStarsbooleanoptional

    • languagesstring[]optional

      Up to 22 items.
    • defaultLanguagestringoptional

      One of text, ts, tsx, js, json, html, xml, yaml, graphql, bash, python, php, java, kotlin, swift, vue, svelte, astro, blade, twig, dockerfile, http.
  • allowedChildren"*" or string[]optional

    * or the keys of blocks its slots may hold.

    Default [].
  • isRootbooleanoptional

    May sit at the top of a page.

    Default true.
  • isNestablebooleanoptional

    May sit inside another block.

    Default true.
  • previewImagestring or nulloptional

    Up to 500 characters.
  • mainHeadingstring or nulloptional

    Up to 64 characters.
  • mainHeadingWhenstring or nulloptional

    Up to 64 characters.
  • hiddenFromLibrarybooleanoptional

Responses

  • 201CreatedThe new item.
    • dataComponent

      Fields of data
      • idstring

        An id.

      • keystring

        Such as hero.

      • namestring

      • descriptionstring or null

      • iconstring or null

      • groupstring or null

      • fieldsField[]

        Fields of Field

      • allowedChildrenstring[] or "*"

        Blocks its slots may hold, or * for any.

      • isRootboolean

        May sit at the top of a page.

      • isNestableboolean

        May sit inside another block.

      • previewImagestring or null

      • mainHeadingstring or null

        The text field that is the page's main heading when the block is used.

      • mainHeadingWhenstring or null

        A yes/no field that decides whether mainHeading counts.

      • hiddenFromLibraryboolean

        Left out of the block library editors pick from.

      • schemaVersioninteger

      • deprecatedboolean

      • updatedAtstring

  • 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.
    • errorobject

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

  • 409ConflictA component with the key exists.
    • errorobject

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

Shell
curl -X POST 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/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

201 CreatedJSON
{  "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, required

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

  • spaceIdstringpath, required

    The space's id.

  • keystringpath, required

    The 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.
    • errorobject

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

  • 404Not foundNo such item with that key, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

  • 409ConflictPages or other components still use it.
    • errorobject

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

Shell
curl -X DELETE 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/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, required

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

  • spaceIdstringpath, required

    The space's id.

  • keystringpath, required

    The key, such as trip, hero or activity.

Responses

  • 200OKThe component.
    • dataComponent

      Fields of data
      • idstring

        An id.

      • keystring

        Such as hero.

      • namestring

      • descriptionstring or null

      • iconstring or null

      • groupstring or null

      • fieldsField[]

        Fields of Field

      • allowedChildrenstring[] or "*"

        Blocks its slots may hold, or * for any.

      • isRootboolean

        May sit at the top of a page.

      • isNestableboolean

        May sit inside another block.

      • previewImagestring or null

      • mainHeadingstring or null

        The text field that is the page's main heading when the block is used.

      • mainHeadingWhenstring or null

        A yes/no field that decides whether mainHeading counts.

      • hiddenFromLibraryboolean

        Left out of the block library editors pick from.

      • schemaVersioninteger

      • deprecatedboolean

      • updatedAtstring

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

  • 403ForbiddenLacks schema:read.
    • errorobject

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

  • 404Not foundNo such item with that key, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

Shell
curl 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/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

200 OKJSON
{  "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, required

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

  • spaceIdstringpath, required

    The space's id.

  • keystringpath, required

    The key, such as trip, hero or activity.

  • Idempotency-Keystringheader

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

    Up to 255 characters.

Request body, optional

  • namestringoptional

    Up to 200 characters.
  • descriptionstring or nulloptional

    Up to 500 characters.
  • iconstring or nulloptional

    Up to 60 characters.
  • groupstring or nulloptional

    Up to 60 characters.
  • fieldsobject[]optional

    Fields of fields
    • keystringrequired

      Up to 64 characters.
    • namestringrequired

      Up to 200 characters.
    • typestringrequired

      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.
    • descriptionstringoptional

      Up to 300 characters.
    • requiredbooleanoptional

      Default false.
    • defaultanyoptional

      Any JSON value.

    • validationobjectoptional

      Fields of validation
      • minnumberoptional

      • maxnumberoptional

      • minLengthintegeroptional

        At least 0.
      • maxLengthintegeroptional

        At least 1.
      • patternstringoptional

        Up to 200 characters.
      • messagestringoptional

        Up to 200 characters.
    • optionsobject[]optional

      Fields of options
      • labelstringrequired

        Up to 120 characters.
      • valuestringrequired

        Up to 120 characters.
    • allowedComponentsstring[]optional

    • allowedContentTypesstring[]optional

    • allowedMimeTypesstring[]optional

    • taxonomyKeystringoptional

      Up to 64 characters.
    • localisedbooleanoptional

    • regionalbooleanoptional

    • protectsstringoptional

      One of none, price, promotion.
    • groupstringoptional

      Up to 60 characters.
    • hiddenbooleanoptional

    • showWhenobjectoptional

      Fields of showWhen
      • fieldstringrequired

        Up to 64 characters.
      • equalsboolean or string or string[]required

    • stepnumberoptional

    • unitstringoptional

      Up to 20 characters.
    • halfStarsbooleanoptional

    • languagesstring[]optional

      Up to 22 items.
    • defaultLanguagestringoptional

      One of text, ts, tsx, js, json, html, xml, yaml, graphql, bash, python, php, java, kotlin, swift, vue, svelte, astro, blade, twig, dockerfile, http.
  • allowedChildren"*" or string[]optional

  • isRootbooleanoptional

  • isNestablebooleanoptional

  • previewImagestring or nulloptional

    Up to 500 characters.
  • deprecatedbooleanoptional

  • mainHeadingstring or nulloptional

    Up to 64 characters.
  • mainHeadingWhenstring or nulloptional

    Up to 64 characters.
  • hiddenFromLibrarybooleanoptional

Responses

  • 200OKThe component.
    • dataComponent

      Fields of data
      • idstring

        An id.

      • keystring

        Such as hero.

      • namestring

      • descriptionstring or null

      • iconstring or null

      • groupstring or null

      • fieldsField[]

        Fields of Field

      • allowedChildrenstring[] or "*"

        Blocks its slots may hold, or * for any.

      • isRootboolean

        May sit at the top of a page.

      • isNestableboolean

        May sit inside another block.

      • previewImagestring or null

      • mainHeadingstring or null

        The text field that is the page's main heading when the block is used.

      • mainHeadingWhenstring or null

        A yes/no field that decides whether mainHeading counts.

      • hiddenFromLibraryboolean

        Left out of the block library editors pick from.

      • schemaVersioninteger

      • deprecatedboolean

      • updatedAtstring

  • 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.
    • errorobject

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

  • 404Not foundNo such item with that key, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

Shell
curl -X PATCH 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/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

200 OKJSON
{  "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, required

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

  • spaceIdstringpath, required

    The space's id.

  • keystringpath, required

    The key, such as trip, hero or activity.

  • Idempotency-Keystringheader

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

    Up to 255 characters.

Request body, optional

  • lockedbooleanoptional

    Only people with brand:manage can change its fields.

  • brandApprovalbooleanoptional

    Changes need brand sign-off before publishing.

Responses

  • 200OK{ locked, brandApproval }.
    • dataobject

      Fields of data
      • lockedboolean

      • brandApprovalboolean

  • 400Bad requestThe body isn't valid JSON.
    • errorobject

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

  • 404Not foundNo such item with that key, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

Shell
curl -X 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

200 OKJSON
{  "data": {    "locked": false,    "brandApproval": false  }}

Every content type

GET/organisations/{organisationId}/spaces/{spaceId}/content-typesKey required

Every content type. Permission: schema:read.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

Responses

  • 200OKList.
    • dataContentType[]

      Fields of data
      • idstring

        An id.

      • keystring

        Such as trip.

      • namestring

      • descriptionstring or null

      • iconstring or null

      • groupstring or null

      • fieldsField[]

        Fields of Field

      • allowedComponentsstring[] or "*"

        Blocks the body may hold, or * for any.

      • templatestring[]

        Blocks a new item starts with.

      • seoobject

        Fields of seo
        • enabledboolean

        • fieldsField[]

          Fields of Field

        • titleTemplatestring or nullsometimes

        • descriptionFieldstring or nullsometimes

        • sitemapPrioritynumber or nullsometimes

        • sitemapChangeFrequencystring or nullsometimes

        • noIndexByDefaultbooleansometimes

      • slugBehaviourobject

        Fields of slugBehaviour
        • sourcestring

          One of name, manual.
        • editableboolean

        • uniqueboolean

      • publishingobject

        Fields of publishing
        • requiresApprovalboolean

        • stepsobject[]sometimes

          Up to 5 approval steps.

          Fields of steps
          • keystring

          • namestring

          • rolestring or nullsometimes

          • permissionstring or nullsometimes

        • regionStepsmap of object[]sometimes

          Approval steps for one region, by region key.

          Fields of regionSteps
          • keystring

          • namestring

          • rolestring or nullsometimes

          • permissionstring or nullsometimes

        • reviewMonthsinteger or nullsometimes

          Months until an item is due for review.

      • isGlobalboolean

        Read by key, with no address, such as a footer.

      • singletonboolean

        Only one item of this type.

      • urlPrefixstring or null

        Where items of this type live, such as /trips.

      • editorstring or null

        One of preview, panel.
      • mainHeadingstring or null

        The text field that is the item's main heading.

      • schemaVersioninteger

        Goes 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.
    • errorobject

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

  • 403ForbiddenLacks schema:read.
    • errorobject

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

Shell
curl 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/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

200 OKJSON
{  "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, required

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

  • spaceIdstringpath, required

    The space's id.

  • Idempotency-Keystringheader

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

    Up to 255 characters.

Request body

  • keystringrequired

    Such as trip. Never changes.

    Up to 64 characters.
  • namestringrequired

    Up to 200 characters.
  • descriptionstring or nulloptional

    Up to 500 characters.
  • iconstring or nulloptional

    Up to 60 characters.
  • groupstring or nulloptional

    Up to 60 characters.
  • fieldsobject[]optional

    The fields. See the Field schema and the field types guide.

    Fields of fields
    • keystringrequired

      Up to 64 characters.
    • namestringrequired

      Up to 200 characters.
    • typestringrequired

      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.
    • descriptionstringoptional

      Up to 300 characters.
    • requiredbooleanoptional

      Default false.
    • defaultanyoptional

      Any JSON value.

    • validationobjectoptional

      Fields of validation
      • minnumberoptional

      • maxnumberoptional

      • minLengthintegeroptional

        At least 0.
      • maxLengthintegeroptional

        At least 1.
      • patternstringoptional

        Up to 200 characters.
      • messagestringoptional

        Up to 200 characters.
    • optionsobject[]optional

      Fields of options
      • labelstringrequired

        Up to 120 characters.
      • valuestringrequired

        Up to 120 characters.
    • allowedComponentsstring[]optional

    • allowedContentTypesstring[]optional

    • allowedMimeTypesstring[]optional

    • taxonomyKeystringoptional

      Up to 64 characters.
    • localisedbooleanoptional

    • regionalbooleanoptional

    • protectsstringoptional

      One of none, price, promotion.
    • groupstringoptional

      Up to 60 characters.
    • hiddenbooleanoptional

    • showWhenobjectoptional

      Fields of showWhen
      • fieldstringrequired

        Up to 64 characters.
      • equalsboolean or string or string[]required

    • stepnumberoptional

    • unitstringoptional

      Up to 20 characters.
    • halfStarsbooleanoptional

    • languagesstring[]optional

      Up to 22 items.
    • defaultLanguagestringoptional

      One of text, ts, tsx, js, json, html, xml, yaml, graphql, bash, python, php, java, kotlin, swift, vue, svelte, astro, blade, twig, dockerfile, http.
  • allowedComponents"*" or string[]optional

    * or the keys of blocks the body may hold.

    Default "*".
  • templatestring[]optional

    Blocks a new item starts with.

    Default [].
  • seoobjectoptional

    Fields of seo
    • enabledbooleanoptional

      Default true.
    • fieldsobject[]optional

      Fields of fields
      • keystringrequired

        Up to 64 characters.
      • namestringrequired

        Up to 200 characters.
      • typestringrequired

        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.
      • descriptionstringoptional

        Up to 300 characters.
      • requiredbooleanoptional

        Default false.
      • defaultanyoptional

        Any JSON value.

      • validationobjectoptional

        Fields of validation
        • minnumberoptional

        • maxnumberoptional

        • minLengthintegeroptional

          At least 0.
        • maxLengthintegeroptional

          At least 1.
        • patternstringoptional

          Up to 200 characters.
        • messagestringoptional

          Up to 200 characters.
      • optionsobject[]optional

        Fields of options
        • labelstringrequired

          Up to 120 characters.
        • valuestringrequired

          Up to 120 characters.
      • allowedComponentsstring[]optional

      • allowedContentTypesstring[]optional

      • allowedMimeTypesstring[]optional

      • taxonomyKeystringoptional

        Up to 64 characters.
      • localisedbooleanoptional

      • regionalbooleanoptional

      • protectsstringoptional

        One of none, price, promotion.
      • groupstringoptional

        Up to 60 characters.
      • hiddenbooleanoptional

      • showWhenobjectoptional

        Fields of showWhen
        • fieldstringrequired

          Up to 64 characters.
        • equalsboolean or string or string[]required

      • stepnumberoptional

      • unitstringoptional

        Up to 20 characters.
      • halfStarsbooleanoptional

      • languagesstring[]optional

        Up to 22 items.
      • defaultLanguagestringoptional

        One of text, ts, tsx, js, json, html, xml, yaml, graphql, bash, python, php, java, kotlin, swift, vue, svelte, astro, blade, twig, dockerfile, http.
    • titleTemplatestring or nulloptional

      Up to 200 characters.
    • descriptionFieldstring or nulloptional

      Up to 60 characters.
    • sitemapPrioritynumber or nulloptional

      At least 0. At most 1.
    • sitemapChangeFrequencystring or nulloptional

      One of always, hourly, daily, weekly, monthly, yearly, never.
  • slugBehaviourobjectoptional

    Default {"source":"name","editable":true,"unique":true}.
    Fields of slugBehaviour
    • sourcestringoptional

      One of name, manual. Default "name".
    • editablebooleanoptional

      Default true.
    • uniquebooleanoptional

      Default true.
  • publishingobjectoptional

    Fields of publishing
    • requiresApprovalbooleanoptional

      Default false.
    • stepsobject[]optional

      Up to 5 items.
      Fields of steps
      • keystringrequired

        Up to 64 characters.
      • namestringrequired

        Up to 200 characters.
      • rolestring or nulloptional

        Up to 64 characters.
    • regionStepsmap of object[]optional

      Fields of regionSteps
      • keystringrequired

        Up to 64 characters.
      • namestringrequired

        Up to 200 characters.
      • rolestring or nulloptional

        Up to 64 characters.
    • reviewMonthsinteger or nulloptional

      At least 1. At most 36.
  • folderRestrictionsstring[]optional

    Default [].
  • isGlobalbooleanoptional

    Read by key, with no address, such as a footer.

    Default false.
  • singletonbooleanoptional

    Only one item of this type.

    Default false.
  • editorstringoptional

    One of preview, panel.
  • mainHeadingstring or nulloptional

    Up to 64 characters.

Responses

  • 201CreatedThe new item.
    • dataContentType

      Fields of data
      • idstring

        An id.

      • keystring

        Such as trip.

      • namestring

      • descriptionstring or null

      • iconstring or null

      • groupstring or null

      • fieldsField[]

        Fields of Field

      • allowedComponentsstring[] or "*"

        Blocks the body may hold, or * for any.

      • templatestring[]

        Blocks a new item starts with.

      • seoobject

        Fields of seo
        • enabledboolean

        • fieldsField[]

          Fields of Field

        • titleTemplatestring or nullsometimes

        • descriptionFieldstring or nullsometimes

        • sitemapPrioritynumber or nullsometimes

        • sitemapChangeFrequencystring or nullsometimes

        • noIndexByDefaultbooleansometimes

      • slugBehaviourobject

        Fields of slugBehaviour
        • sourcestring

          One of name, manual.
        • editableboolean

        • uniqueboolean

      • publishingobject

        Fields of publishing
        • requiresApprovalboolean

        • stepsobject[]sometimes

          Up to 5 approval steps.

          Fields of steps
          • keystring

          • namestring

          • rolestring or nullsometimes

          • permissionstring or nullsometimes

        • regionStepsmap of object[]sometimes

          Approval steps for one region, by region key.

          Fields of regionSteps
          • keystring

          • namestring

          • rolestring or nullsometimes

          • permissionstring or nullsometimes

        • reviewMonthsinteger or nullsometimes

          Months until an item is due for review.

      • isGlobalboolean

        Read by key, with no address, such as a footer.

      • singletonboolean

        Only one item of this type.

      • urlPrefixstring or null

        Where items of this type live, such as /trips.

      • editorstring or null

        One of preview, panel.
      • mainHeadingstring or null

        The text field that is the item's main heading.

      • schemaVersioninteger

        Goes 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.
    • errorobject

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

  • 403ForbiddenLacks schema:manage, or approval steps or review dates on a plan without them.
    • errorobject

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

  • 409ConflictA content type with the key exists.
    • errorobject

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

Shell
curl -X POST 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/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

201 CreatedJSON
{  "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, required

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

  • spaceIdstringpath, required

    The space's id.

  • keystringpath, required

    The 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.
    • errorobject

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

  • 404Not foundNo such item with that key, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

  • 409ConflictContent still uses it.
    • errorobject

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

Shell
curl -X DELETE 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/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, required

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

  • spaceIdstringpath, required

    The space's id.

  • keystringpath, required

    The key, such as trip, hero or activity.

Responses

  • 200OKThe content type.
    • dataContentType

      Fields of data
      • idstring

        An id.

      • keystring

        Such as trip.

      • namestring

      • descriptionstring or null

      • iconstring or null

      • groupstring or null

      • fieldsField[]

        Fields of Field

      • allowedComponentsstring[] or "*"

        Blocks the body may hold, or * for any.

      • templatestring[]

        Blocks a new item starts with.

      • seoobject

        Fields of seo
        • enabledboolean

        • fieldsField[]

          Fields of Field

        • titleTemplatestring or nullsometimes

        • descriptionFieldstring or nullsometimes

        • sitemapPrioritynumber or nullsometimes

        • sitemapChangeFrequencystring or nullsometimes

        • noIndexByDefaultbooleansometimes

      • slugBehaviourobject

        Fields of slugBehaviour
        • sourcestring

          One of name, manual.
        • editableboolean

        • uniqueboolean

      • publishingobject

        Fields of publishing
        • requiresApprovalboolean

        • stepsobject[]sometimes

          Up to 5 approval steps.

          Fields of steps
          • keystring

          • namestring

          • rolestring or nullsometimes

          • permissionstring or nullsometimes

        • regionStepsmap of object[]sometimes

          Approval steps for one region, by region key.

          Fields of regionSteps
          • keystring

          • namestring

          • rolestring or nullsometimes

          • permissionstring or nullsometimes

        • reviewMonthsinteger or nullsometimes

          Months until an item is due for review.

      • isGlobalboolean

        Read by key, with no address, such as a footer.

      • singletonboolean

        Only one item of this type.

      • urlPrefixstring or null

        Where items of this type live, such as /trips.

      • editorstring or null

        One of preview, panel.
      • mainHeadingstring or null

        The text field that is the item's main heading.

      • schemaVersioninteger

        Goes 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.
    • errorobject

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

  • 403ForbiddenLacks schema:read.
    • errorobject

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

  • 404Not foundNo such item with that key, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

Shell
curl 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/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

200 OKJSON
{  "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, required

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

  • spaceIdstringpath, required

    The space's id.

  • keystringpath, required

    The key, such as trip, hero or activity.

  • Idempotency-Keystringheader

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

    Up to 255 characters.

Request body, optional

  • namestringoptional

    Up to 200 characters.
  • urlPrefixstring or nulloptional

    Where items of this type live, such as /trips.

    Up to 100 characters.
  • descriptionstring or nulloptional

    Up to 500 characters.
  • iconstring or nulloptional

    Up to 60 characters.
  • groupstring or nulloptional

    Up to 60 characters.
  • fieldsobject[]optional

    Fields of fields
    • keystringrequired

      Up to 64 characters.
    • namestringrequired

      Up to 200 characters.
    • typestringrequired

      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.
    • descriptionstringoptional

      Up to 300 characters.
    • requiredbooleanoptional

      Default false.
    • defaultanyoptional

      Any JSON value.

    • validationobjectoptional

      Fields of validation
      • minnumberoptional

      • maxnumberoptional

      • minLengthintegeroptional

        At least 0.
      • maxLengthintegeroptional

        At least 1.
      • patternstringoptional

        Up to 200 characters.
      • messagestringoptional

        Up to 200 characters.
    • optionsobject[]optional

      Fields of options
      • labelstringrequired

        Up to 120 characters.
      • valuestringrequired

        Up to 120 characters.
    • allowedComponentsstring[]optional

    • allowedContentTypesstring[]optional

    • allowedMimeTypesstring[]optional

    • taxonomyKeystringoptional

      Up to 64 characters.
    • localisedbooleanoptional

    • regionalbooleanoptional

    • protectsstringoptional

      One of none, price, promotion.
    • groupstringoptional

      Up to 60 characters.
    • hiddenbooleanoptional

    • showWhenobjectoptional

      Fields of showWhen
      • fieldstringrequired

        Up to 64 characters.
      • equalsboolean or string or string[]required

    • stepnumberoptional

    • unitstringoptional

      Up to 20 characters.
    • halfStarsbooleanoptional

    • languagesstring[]optional

      Up to 22 items.
    • defaultLanguagestringoptional

      One of text, ts, tsx, js, json, html, xml, yaml, graphql, bash, python, php, java, kotlin, swift, vue, svelte, astro, blade, twig, dockerfile, http.
  • allowedComponents"*" or string[]optional

  • templatestring[]optional

  • seoobjectoptional

    Fields of seo
    • enabledbooleanoptional

    • fieldsobject[]optional

      Fields of fields
      • keystringrequired

        Up to 64 characters.
      • namestringrequired

        Up to 200 characters.
      • typestringrequired

        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.
      • descriptionstringoptional

        Up to 300 characters.
      • requiredbooleanoptional

        Default false.
      • defaultanyoptional

        Any JSON value.

      • validationobjectoptional

        Fields of validation
        • minnumberoptional

        • maxnumberoptional

        • minLengthintegeroptional

          At least 0.
        • maxLengthintegeroptional

          At least 1.
        • patternstringoptional

          Up to 200 characters.
        • messagestringoptional

          Up to 200 characters.
      • optionsobject[]optional

        Fields of options
        • labelstringrequired

          Up to 120 characters.
        • valuestringrequired

          Up to 120 characters.
      • allowedComponentsstring[]optional

      • allowedContentTypesstring[]optional

      • allowedMimeTypesstring[]optional

      • taxonomyKeystringoptional

        Up to 64 characters.
      • localisedbooleanoptional

      • regionalbooleanoptional

      • protectsstringoptional

        One of none, price, promotion.
      • groupstringoptional

        Up to 60 characters.
      • hiddenbooleanoptional

      • showWhenobjectoptional

        Fields of showWhen
        • fieldstringrequired

          Up to 64 characters.
        • equalsboolean or string or string[]required

      • stepnumberoptional

      • unitstringoptional

        Up to 20 characters.
      • halfStarsbooleanoptional

      • languagesstring[]optional

        Up to 22 items.
      • defaultLanguagestringoptional

        One of text, ts, tsx, js, json, html, xml, yaml, graphql, bash, python, php, java, kotlin, swift, vue, svelte, astro, blade, twig, dockerfile, http.
    • titleTemplatestring or nulloptional

      Up to 200 characters.
    • descriptionFieldstring or nulloptional

      Up to 60 characters.
    • sitemapPrioritynumber or nulloptional

      At least 0. At most 1.
    • sitemapChangeFrequencystring or nulloptional

      One of always, hourly, daily, weekly, monthly, yearly, never.
  • slugBehaviourobjectoptional

    Fields of slugBehaviour
    • sourcestringoptional

      One of name, manual.
    • editablebooleanoptional

    • uniquebooleanoptional

  • publishingobjectoptional

    Fields of publishing
    • requiresApprovalbooleanoptional

      Default false.
    • stepsobject[]optional

      Up to 5 items.
      Fields of steps
      • keystringrequired

        Up to 64 characters.
      • namestringrequired

        Up to 200 characters.
      • rolestring or nulloptional

        Up to 64 characters.
    • regionStepsmap of object[]optional

      Fields of regionSteps
      • keystringrequired

        Up to 64 characters.
      • namestringrequired

        Up to 200 characters.
      • rolestring or nulloptional

        Up to 64 characters.
    • reviewMonthsinteger or nulloptional

      At least 1. At most 36.
  • folderRestrictionsstring[]optional

  • isGlobalbooleanoptional

  • singletonbooleanoptional

  • editorstringoptional

    One of preview, panel.
  • mainHeadingstring or nulloptional

    Up to 64 characters.

Responses

  • 200OKThe content type.
    • dataContentType

      Fields of data
      • idstring

        An id.

      • keystring

        Such as trip.

      • namestring

      • descriptionstring or null

      • iconstring or null

      • groupstring or null

      • fieldsField[]

        Fields of Field

      • allowedComponentsstring[] or "*"

        Blocks the body may hold, or * for any.

      • templatestring[]

        Blocks a new item starts with.

      • seoobject

        Fields of seo
        • enabledboolean

        • fieldsField[]

          Fields of Field

        • titleTemplatestring or nullsometimes

        • descriptionFieldstring or nullsometimes

        • sitemapPrioritynumber or nullsometimes

        • sitemapChangeFrequencystring or nullsometimes

        • noIndexByDefaultbooleansometimes

      • slugBehaviourobject

        Fields of slugBehaviour
        • sourcestring

          One of name, manual.
        • editableboolean

        • uniqueboolean

      • publishingobject

        Fields of publishing
        • requiresApprovalboolean

        • stepsobject[]sometimes

          Up to 5 approval steps.

          Fields of steps
          • keystring

          • namestring

          • rolestring or nullsometimes

          • permissionstring or nullsometimes

        • regionStepsmap of object[]sometimes

          Approval steps for one region, by region key.

          Fields of regionSteps
          • keystring

          • namestring

          • rolestring or nullsometimes

          • permissionstring or nullsometimes

        • reviewMonthsinteger or nullsometimes

          Months until an item is due for review.

      • isGlobalboolean

        Read by key, with no address, such as a footer.

      • singletonboolean

        Only one item of this type.

      • urlPrefixstring or null

        Where items of this type live, such as /trips.

      • editorstring or null

        One of preview, panel.
      • mainHeadingstring or null

        The text field that is the item's main heading.

      • schemaVersioninteger

        Goes 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.
    • errorobject

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

  • 404Not foundNo such item with that key, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

Shell
curl -X PATCH 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/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

200 OKJSON
{  "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, required

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

  • spaceIdstringpath, required

    The space's id.

Responses

  • 200OK{ contentTypes, components, fieldTypes, canManage }.
    • dataobject

      Fields of data
      • contentTypesContentType[]

        Fields of ContentType

      • componentsComponent[]

        Fields of Component

      • fieldTypesobject[]

        Every field type this server knows.

        Fields of fieldTypes
        • typestring

          Such as text.

        • labelstring

        • groupstring

          Such as text, choice, relation or structure.

        • supportsOptionsboolean

        • supportsComponentsboolean

        • supportsContentTypesboolean

        • supportsTaxonomyboolean

      • canManageboolean

        You may change the schema (schema:manage).

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

  • 403ForbiddenLacks schema:read.
    • errorobject

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

Shell
curl 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/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

200 OKJSON
{  "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, required

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

  • spaceIdstringpath, required

    The space's id.

Responses

  • 200OK{ contentTypes, components }.
    • dataobject

      Fields of data
      • contentTypesmap of object

        By content type key. Types no entry uses are left out.

        Fields of contentTypes
        • entriesinteger

          Entries of the type, in every environment, region and language, the bin left out.

        • fieldsmap of integer

          By field key: entries holding a value in it, drafted or published.

      • componentsmap of object

        By component key. Components no entry uses are left out.

        Fields of components
        • entriesinteger

          Entries with the block anywhere, drafted or published.

        • fieldsmap of integer

          By 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.
    • errorobject

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

  • 403ForbiddenLacks schema:read.
    • errorobject

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

Shell
curl 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/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

200 OKJSON
{  "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, required

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

  • spaceIdstringpath, required

    The space's id.

  • environmentIdstringpath, required

    The environment's id.

  • regionIdstringpath, required

    The region's id.

  • localeIdstringpath, required

    The language's id.

  • keystringpath, required

    The key, such as trip, hero or activity.

Responses

  • 200OK[{ contentId, page, url, summary, node }].
    • dataobject[]

      Up to 24 pages.

      Fields of data
      • contentIdstring

        An id.

      • pagestring

        The page's name.

      • urlstring or null

      • summarystring or null

        The block's main text.

      • nodeBlock

        One block in a page body.

        Fields of Block

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

  • 403ForbiddenLacks content:read.
    • errorobject

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

  • 404Not foundNo such item with that key, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

Shell
curl 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/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

200 OKJSON
{  "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.

  • errorobject

    Fields of error
    • codestring

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

      Follows Accept-Language when CMS Orbit has the language.

    • detailsanysometimes

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

Field

  • keystring

    Such as title.

  • namestring

  • typestring

    Such as text, richtext, asset or reference. See https://docs.bifrostorbit.com/cms/developers/field-types/.

  • descriptionstringsometimes

  • requiredboolean

  • defaultanysometimes

  • validationobjectsometimes

    Fields of validation
    • minnumbersometimes

    • maxnumbersometimes

    • minLengthintegersometimes

    • maxLengthintegersometimes

    • patternstringsometimes

    • messagestringsometimes

  • optionsobject[]sometimes

    Fields of options
    • labelstring

    • valuestring

  • allowedComponentsstring[]sometimes

  • allowedContentTypesstring[]sometimes

  • allowedMimeTypesstring[]sometimes

  • taxonomyKeystringsometimes

  • localisedbooleansometimes

  • regionalbooleansometimes

  • protectsstringsometimes

    One of none, price, promotion.
  • groupstringsometimes

  • hiddenbooleansometimes

  • showWhenobjectsometimes

    Show and check the field only while another field has this value.

    Fields of showWhen
    • fieldstring

    • equalsany

      A value, true or false, or a list of values.

  • stepnumbersometimes

    Slider: how far one move goes, such as 0.5. 1 when left out.

  • unitstringsometimes

    Slider: a unit shown after the value, such as km or %. Up to 20 characters.

  • halfStarsbooleansometimes

    Star rating: allow half stars, such as 3.5.

  • languagesstring[]sometimes

    Code block: the languages editors may choose. Every language when left out or empty.

  • defaultLanguagestringsometimes

    Code 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

  • idstring

    An id.

  • keystring

    Such as trip.

  • namestring

  • descriptionstring or null

  • iconstring or null

  • groupstring or null

  • fieldsField[]

    Fields of Field

  • allowedComponentsstring[] or "*"

    Blocks the body may hold, or * for any.

  • templatestring[]

    Blocks a new item starts with.

  • seoobject

    Fields of seo
    • enabledboolean

    • fieldsField[]

      Fields of Field

    • titleTemplatestring or nullsometimes

    • descriptionFieldstring or nullsometimes

    • sitemapPrioritynumber or nullsometimes

    • sitemapChangeFrequencystring or nullsometimes

    • noIndexByDefaultbooleansometimes

  • slugBehaviourobject

    Fields of slugBehaviour
    • sourcestring

      One of name, manual.
    • editableboolean

    • uniqueboolean

  • publishingobject

    Fields of publishing
    • requiresApprovalboolean

    • stepsobject[]sometimes

      Up to 5 approval steps.

      Fields of steps
      • keystring

      • namestring

      • rolestring or nullsometimes

      • permissionstring or nullsometimes

    • regionStepsmap of object[]sometimes

      Approval steps for one region, by region key.

      Fields of regionSteps
      • keystring

      • namestring

      • rolestring or nullsometimes

      • permissionstring or nullsometimes

    • reviewMonthsinteger or nullsometimes

      Months until an item is due for review.

  • isGlobalboolean

    Read by key, with no address, such as a footer.

  • singletonboolean

    Only one item of this type.

  • urlPrefixstring or null

    Where items of this type live, such as /trips.

  • editorstring or null

    One of preview, panel.
  • mainHeadingstring or null

    The text field that is the item's main heading.

  • schemaVersioninteger

    Goes up each time the fields change.

  • updatedAtstring

Component

  • idstring

    An id.

  • keystring

    Such as hero.

  • namestring

  • descriptionstring or null

  • iconstring or null

  • groupstring or null

  • fieldsField[]

    Fields of Field

  • allowedChildrenstring[] or "*"

    Blocks its slots may hold, or * for any.

  • isRootboolean

    May sit at the top of a page.

  • isNestableboolean

    May sit inside another block.

  • previewImagestring or null

  • mainHeadingstring or null

    The text field that is the page's main heading when the block is used.

  • mainHeadingWhenstring or null

    A yes/no field that decides whether mainHeading counts.

  • hiddenFromLibraryboolean

    Left out of the block library editors pick from.

  • schemaVersioninteger

  • deprecatedboolean

  • updatedAtstring

Block

One block in a page body.

  • idstring

  • typestring

    The component's key, such as hero.

  • schemaVersioninteger

  • fieldsmap of any

    The component's fields.

  • childrenmap of Block[]

    Further blocks by slot.

    Fields of children
    • idstring

    • typestring

      The component's key, such as hero.

    • schemaVersioninteger

    • fieldsmap of any

      The component's fields.

    • childrenmap of Block[]

      Further blocks by slot.

      Fields of children
      • idstring

      • typestring

        The component's key, such as hero.

      • schemaVersioninteger

      • fieldsmap of any

        The component's fields.

      • childrenmap of Block[]

        Further blocks by slot.

        Fields of children
        • idstring

        • typestring

          The component's key, such as hero.

        • schemaVersioninteger

        • fieldsmap of any

          The component's fields.

        • childrenmap of Block[]

          Further blocks by slot.

        • variantstring or null

      • variantstring or null

    • variantstring or null

  • variantstring or null