Skip to content

Reviews

Reviews in the management API. 8 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.

Its latest review, or null

GET/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}/reviewKey required

Its latest review, or null. 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.

  • contentIdstringpath, required

    The content item's id.

Responses

  • 200OKThe review.
    • dataReview or any or null

      Fields of data

      One of:

      Review

      • idstring

        An id.

      • contentIdstring

        An id.

      • contentNamestring

      • contentUrlstring or null

      • contentTypestring

      • regionstring or null

      • localestring or null

      • environmentIdstring

        An id.

      • regionIdstring

        An id.

      • localeIdstring

        An id.

      • versioninteger

        The draft version sent.

      • statusstring

        One of pending, approved, rejected, withdrawn, superseded.
      • stepsobject[]

        Fields of steps
        • keystring

        • namestring

        • statusstring

          One of pending, approved, rejected.
        • decidedBystring or null

        • decidedRolestring or null

        • decidedAtstring or null

        • commentstring or null

        • whostring or null

      • messagestring or null

      • reviewersstring[]

      • publishOnApprovalboolean

      • submittedBystring

      • sentByAgentstring or null

      • draftedByAistring or null

      • submittedAtstring

      • decidedAtstring or null

      • publishedAtstring or null

      • staleboolean

        The page changed after it was sent.

      any or null

  • 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 content item, 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/content/6650f1c2a9e4b1d2c3f40a21/review' \  -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": "6650f1c2a9e4b1d2c3f40a46",    "contentId": "6650f1c2a9e4b1d2c3f40a21",    "contentName": "Lofoten sea kayaking",    "contentUrl": "/trips/lofoten-sea-kayaking",    "contentType": "trip",    "region": "Norway",    "locale": "Norsk",    "environmentId": "6650f1c2a9e4b1d2c3f40a13",    "regionId": "6650f1c2a9e4b1d2c3f40a17",    "localeId": "6650f1c2a9e4b1d2c3f40a18",    "version": 12,    "status": "pending",    "steps": [      {        "key": "lofoten",        "name": "Lofoten sea kayaking",        "status": "pending",        "decidedBy": "6650f1c2a9e4b1d2c3f40a30",        "decidedRole": null,        "decidedAt": "2026-11-02T09:30:00.000Z",        "comment": null,        "who": null      }    ],    "message": null,    "reviewers": [      "…"    ],    "publishOnApproval": true,    "submittedBy": "Ingrid Berg",    "sentByAgent": null,    "draftedByAi": null,    "submittedAt": "2026-11-02T09:30:00.000Z",    "decidedAt": "2026-11-02T09:30:00.000Z",    "publishedAt": "2026-11-02T09:30:00.000Z",    "stale": false  }}

Sends the draft for review

POST/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}/reviewKey required

Sends the draft for review. Permission: content:update.

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.

  • contentIdstringpath, required

    The content item'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, optional

  • messagestring or nulloptional

    What to look at, up to 2,000 characters.

    Default null. Up to 2000 characters.
  • reviewerIdsstring[]optional

    Up to 20 people to ask, from GET {space}/reviewers.

    Default []. Up to 20 items.
  • publishOnApprovalbooleanoptional

    Publish as soon as it's approved.

    Default true.

Responses

  • 201CreatedThe review.
    • dataReview

      Fields of data
      • idstring

        An id.

      • contentIdstring

        An id.

      • contentNamestring

      • contentUrlstring or null

      • contentTypestring

      • regionstring or null

      • localestring or null

      • environmentIdstring

        An id.

      • regionIdstring

        An id.

      • localeIdstring

        An id.

      • versioninteger

        The draft version sent.

      • statusstring

        One of pending, approved, rejected, withdrawn, superseded.
      • stepsobject[]

        Fields of steps
        • keystring

        • namestring

        • statusstring

          One of pending, approved, rejected.
        • decidedBystring or null

        • decidedRolestring or null

        • decidedAtstring or null

        • commentstring or null

        • whostring or null

      • messagestring or null

      • reviewersstring[]

      • publishOnApprovalboolean

      • submittedBystring

      • sentByAgentstring or null

      • draftedByAistring or null

      • submittedAtstring

      • decidedAtstring or null

      • publishedAtstring or null

      • staleboolean

        The page changed after it was sent.

  • 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 content:update, 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 content item, 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.

  • 409ConflictNothing new to review.
    • 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/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21/review' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"message":"New 2027 departures and prices.","reviewerIds":["6650f1c2a9e4b1d2c3f40a30"]}'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

Example answer

201 CreatedJSON
{  "data": {    "id": "6650f1c2a9e4b1d2c3f40a46",    "contentId": "6650f1c2a9e4b1d2c3f40a21",    "contentName": "Lofoten sea kayaking",    "contentUrl": "/trips/lofoten-sea-kayaking",    "contentType": "trip",    "region": "Norway",    "locale": "Norsk",    "environmentId": "6650f1c2a9e4b1d2c3f40a13",    "regionId": "6650f1c2a9e4b1d2c3f40a17",    "localeId": "6650f1c2a9e4b1d2c3f40a18",    "version": 12,    "status": "pending",    "steps": [      {        "key": "lofoten",        "name": "Lofoten sea kayaking",        "status": "pending",        "decidedBy": "6650f1c2a9e4b1d2c3f40a30",        "decidedRole": null,        "decidedAt": "2026-11-02T09:30:00.000Z",        "comment": null,        "who": null      }    ],    "message": null,    "reviewers": [      "…"    ],    "publishOnApproval": true,    "submittedBy": "Ingrid Berg",    "sentByAgent": null,    "draftedByAi": null,    "submittedAt": "2026-11-02T09:30:00.000Z",    "decidedAt": "2026-11-02T09:30:00.000Z",    "publishedAt": "2026-11-02T09:30:00.000Z",    "stale": false  }}

Who can be asked to review

GET/organisations/{organisationId}/spaces/{spaceId}/reviewersKey required

Who can be asked to review. Permission: content:update.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

Responses

  • 200OK[{ userId, name, email, roleName, role, canApprove, invited }].
    • dataobject[]

      Fields of data
      • userIdstring

        An id.

      • namestring

      • emailstring

      • roleNamestring

      • rolestring

      • canApproveboolean

      • invitedboolean

        Hasn't accepted the invitation yet.

  • 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:update.
    • 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/reviewers' \  -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": [    {      "userId": "6650f1c2a9e4b1d2c3f40a30",      "name": "Lofoten sea kayaking",      "email": "ingrid.berg@northwilds.com",      "roleName": "…",      "role": "…",      "canApprove": false,      "invited": false    }  ]}

Reviews

GET/organisations/{organisationId}/spaces/{spaceId}/reviewsKey required

Reviews. status is open (default) or decided; mine=true. Up to 100. Permission: content:read.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

  • statusstringquery

    open (the default) or decided.

    One of open, decided.
  • minestringquery

    true for reviews you sent or were asked to do.

    One of true, false.

Responses

  • 200OKList of reviews.
    • dataReview[]

      Up to 100.

      Fields of data
      • idstring

        An id.

      • contentIdstring

        An id.

      • contentNamestring

      • contentUrlstring or null

      • contentTypestring

      • regionstring or null

      • localestring or null

      • environmentIdstring

        An id.

      • regionIdstring

        An id.

      • localeIdstring

        An id.

      • versioninteger

        The draft version sent.

      • statusstring

        One of pending, approved, rejected, withdrawn, superseded.
      • stepsobject[]

        Fields of steps
        • keystring

        • namestring

        • statusstring

          One of pending, approved, rejected.
        • decidedBystring or null

        • decidedRolestring or null

        • decidedAtstring or null

        • commentstring or null

        • whostring or null

      • messagestring or null

      • reviewersstring[]

      • publishOnApprovalboolean

      • submittedBystring

      • sentByAgentstring or null

      • draftedByAistring or null

      • submittedAtstring

      • decidedAtstring or null

      • publishedAtstring or null

      • staleboolean

        The page changed after it was sent.

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

  • 403ForbiddenLacks 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 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/reviews' \  -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": "6650f1c2a9e4b1d2c3f40a46",      "contentId": "6650f1c2a9e4b1d2c3f40a21",      "contentName": "Lofoten sea kayaking",      "contentUrl": "/trips/lofoten-sea-kayaking",      "contentType": "trip",      "region": "Norway",      "locale": "Norsk",      "environmentId": "6650f1c2a9e4b1d2c3f40a13",      "regionId": "6650f1c2a9e4b1d2c3f40a17",      "localeId": "6650f1c2a9e4b1d2c3f40a18",      "version": 12,      "status": "pending",      "steps": [        {          "key": "lofoten",          "name": "Lofoten sea kayaking",          "status": "pending",          "decidedBy": "6650f1c2a9e4b1d2c3f40a30",          "decidedRole": null,          "decidedAt": "2026-11-02T09:30:00.000Z",          "comment": null,          "who": null        }      ],      "message": null,      "reviewers": [        "…"      ],      "publishOnApproval": true,      "submittedBy": "Ingrid Berg",      "sentByAgent": null,      "draftedByAi": null,      "submittedAt": "2026-11-02T09:30:00.000Z",      "decidedAt": "2026-11-02T09:30:00.000Z",      "publishedAt": "2026-11-02T09:30:00.000Z",      "stale": false    }  ]}

One review, with its changes and comments

GET/organisations/{organisationId}/spaces/{spaceId}/reviews/{reviewId}Key required

One review, with its changes and comments. Permission: content:read.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

  • reviewIdstringpath, required

    The review's id.

Responses

  • 200OKThe review.
    • dataobject

      Fields of data
      • idstring

        An id.

      • contentIdstring

        An id.

      • contentNamestring

      • contentUrlstring or null

      • contentTypestring

      • regionstring or null

      • localestring or null

      • environmentIdstring

        An id.

      • regionIdstring

        An id.

      • localeIdstring

        An id.

      • versioninteger

        The draft version sent.

      • statusstring

        One of pending, approved, rejected, withdrawn, superseded.
      • stepsobject[]

        Fields of steps
        • keystring

        • namestring

        • statusstring

          One of pending, approved, rejected.
        • decidedBystring or null

        • decidedRolestring or null

        • decidedAtstring or null

        • commentstring or null

        • whostring or null

      • messagestring or null

      • reviewersstring[]

      • publishOnApprovalboolean

      • submittedBystring

      • sentByAgentstring or null

      • draftedByAistring or null

      • submittedAtstring

      • decidedAtstring or null

      • publishedAtstring or null

      • staleboolean

        The page changed after it was sent.

      • changesobject[]

        What the draft changes.

        Fields of changes
        • areastring

          One of field, seo, component.
        • keystring

        • typestringsometimes

        • changestring

          One of added, removed, changed.
        • fieldsstring[]sometimes

      • isNewboolean

        The page has never been published.

      • commentsobject[]

        Fields of comments
        • idstring

          An id.

        • authorstring

        • bodystring

        • componentIdstring or null

        • createdAtstring

      • canDecideboolean

      • decideBlockedstring or null

        Why the token's person can't decide, such as their own changes.

      • decideBlockedWordingany or any or null

        The same as a translation key.

      • canWithdrawboolean

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

  • 403ForbiddenThe review is in a region or language the token's person can't 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 review, 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/reviews/6650f1c2a9e4b1d2c3f40a30' \  -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": "6650f1c2a9e4b1d2c3f40a40",    "contentId": "6650f1c2a9e4b1d2c3f40a21",    "contentName": "…",    "contentUrl": null,    "contentType": "…",    "region": null,    "locale": "nb-NO",    "environmentId": "6650f1c2a9e4b1d2c3f40a13",    "regionId": "6650f1c2a9e4b1d2c3f40a17",    "localeId": "6650f1c2a9e4b1d2c3f40a18",    "version": 12,    "status": "pending",    "steps": [      {        "key": "lofoten",        "name": "Lofoten sea kayaking",        "status": "pending",        "decidedBy": "6650f1c2a9e4b1d2c3f40a30",        "decidedRole": null,        "decidedAt": "2026-11-02T09:30:00.000Z",        "comment": null,        "who": null      }    ],    "message": null,    "reviewers": [      "…"    ],    "publishOnApproval": true,    "submittedBy": "6650f1c2a9e4b1d2c3f40a30",    "sentByAgent": null,    "draftedByAi": null,    "submittedAt": "2026-11-02T09:30:00.000Z",    "decidedAt": "2026-11-02T09:30:00.000Z",    "publishedAt": "2026-11-02T09:30:00.000Z",    "stale": false,    "changes": [      {        "area": "field",        "key": "lofoten",        "type": "…",        "change": "added",        "fields": [          "…"        ]      }    ],    "isNew": false,    "comments": [      {        "id": "6650f1c2a9e4b1d2c3f40a40",        "author": "Ingrid Berg",        "body": "…",        "componentId": null,        "createdAt": "2026-11-02T09:30:00.000Z"      }    ],    "canDecide": true,    "decideBlocked": null,    "decideBlockedWording": null,    "canWithdraw": false  }}

Comments on a review

POST/organisations/{organisationId}/spaces/{spaceId}/reviews/{reviewId}/commentsKey required

Comments on a review. Permission: content:read.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

  • reviewIdstringpath, required

    The review'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

  • bodystringrequired

    Up to 4000 characters.
  • componentIdstring or nulloptional

    A block the comment is about.

    Default null. Up to 100 characters.

Responses

  • 201CreatedThe comment.
    • dataobject

      Fields of data
      • idstring

        An id.

      • bodystring

      • componentIdstring or null

      • createdAtstring

  • 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 content:read, 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 review, 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 POST 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/reviews/6650f1c2a9e4b1d2c3f40a30/comments' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"body":"Could the second paragraph name the fjords?"}'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

Example answer

201 CreatedJSON
{  "data": {    "id": "6650f1c2a9e4b1d2c3f40a40",    "body": "…",    "componentId": null,    "createdAt": "2026-11-02T09:30:00.000Z"  }}

Approves or rejects

POST/organisations/{organisationId}/spaces/{spaceId}/reviews/{reviewId}/decisionKey required

Approves or rejects. Permission: content:approve.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

  • reviewIdstringpath, required

    The review'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

  • decisionstringrequired

    One of approve, reject.
  • commentstring or nulloptional

    Required to reject: what needs to change.

    Default null. Up to 2000 characters.

Responses

  • 200OKThe review.
    • dataReview

      Fields of data
      • idstring

        An id.

      • contentIdstring

        An id.

      • contentNamestring

      • contentUrlstring or null

      • contentTypestring

      • regionstring or null

      • localestring or null

      • environmentIdstring

        An id.

      • regionIdstring

        An id.

      • localeIdstring

        An id.

      • versioninteger

        The draft version sent.

      • statusstring

        One of pending, approved, rejected, withdrawn, superseded.
      • stepsobject[]

        Fields of steps
        • keystring

        • namestring

        • statusstring

          One of pending, approved, rejected.
        • decidedBystring or null

        • decidedRolestring or null

        • decidedAtstring or null

        • commentstring or null

        • whostring or null

      • messagestring or null

      • reviewersstring[]

      • publishOnApprovalboolean

      • submittedBystring

      • sentByAgentstring or null

      • draftedByAistring or null

      • submittedAtstring

      • decidedAtstring or null

      • publishedAtstring or null

      • staleboolean

        The page changed after it was sent.

  • 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 content:approve, or your own changes.
    • 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 review, 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.

  • 409ConflictIt isn't open, the page changed after it was sent, or someone else decided first.
    • 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/reviews/6650f1c2a9e4b1d2c3f40a30/decision' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"decision":"approve","comment":"Looks good."}'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

Example answer

200 OKJSON
{  "data": {    "id": "6650f1c2a9e4b1d2c3f40a46",    "contentId": "6650f1c2a9e4b1d2c3f40a21",    "contentName": "Lofoten sea kayaking",    "contentUrl": "/trips/lofoten-sea-kayaking",    "contentType": "trip",    "region": "Norway",    "locale": "Norsk",    "environmentId": "6650f1c2a9e4b1d2c3f40a13",    "regionId": "6650f1c2a9e4b1d2c3f40a17",    "localeId": "6650f1c2a9e4b1d2c3f40a18",    "version": 12,    "status": "pending",    "steps": [      {        "key": "lofoten",        "name": "Lofoten sea kayaking",        "status": "pending",        "decidedBy": "6650f1c2a9e4b1d2c3f40a30",        "decidedRole": null,        "decidedAt": "2026-11-02T09:30:00.000Z",        "comment": null,        "who": null      }    ],    "message": null,    "reviewers": [      "…"    ],    "publishOnApproval": true,    "submittedBy": "Ingrid Berg",    "sentByAgent": null,    "draftedByAi": null,    "submittedAt": "2026-11-02T09:30:00.000Z",    "decidedAt": "2026-11-02T09:30:00.000Z",    "publishedAt": "2026-11-02T09:30:00.000Z",    "stale": false  }}

Withdraws a review

POST/organisations/{organisationId}/spaces/{spaceId}/reviews/{reviewId}/withdrawKey required

Withdraws a review. Permission: Its sender, or content:approve.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

  • reviewIdstringpath, required

    The review'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.

Responses

  • 200OKThe review.
    • dataReview

      Fields of data
      • idstring

        An id.

      • contentIdstring

        An id.

      • contentNamestring

      • contentUrlstring or null

      • contentTypestring

      • regionstring or null

      • localestring or null

      • environmentIdstring

        An id.

      • regionIdstring

        An id.

      • localeIdstring

        An id.

      • versioninteger

        The draft version sent.

      • statusstring

        One of pending, approved, rejected, withdrawn, superseded.
      • stepsobject[]

        Fields of steps
        • keystring

        • namestring

        • statusstring

          One of pending, approved, rejected.
        • decidedBystring or null

        • decidedRolestring or null

        • decidedAtstring or null

        • commentstring or null

        • whostring or null

      • messagestring or null

      • reviewersstring[]

      • publishOnApprovalboolean

      • submittedBystring

      • sentByAgentstring or null

      • draftedByAistring or null

      • submittedAtstring

      • decidedAtstring or null

      • publishedAtstring or null

      • staleboolean

        The page changed after it was sent.

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

      Fields of error
      • codestring

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

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

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

  • 403ForbiddenLacks Its sender, or content:approve, 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 review, 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.

  • 409ConflictIt isn't open.
    • 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/reviews/6650f1c2a9e4b1d2c3f40a30/withdraw' \  -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": "6650f1c2a9e4b1d2c3f40a46",    "contentId": "6650f1c2a9e4b1d2c3f40a21",    "contentName": "Lofoten sea kayaking",    "contentUrl": "/trips/lofoten-sea-kayaking",    "contentType": "trip",    "region": "Norway",    "locale": "Norsk",    "environmentId": "6650f1c2a9e4b1d2c3f40a13",    "regionId": "6650f1c2a9e4b1d2c3f40a17",    "localeId": "6650f1c2a9e4b1d2c3f40a18",    "version": 12,    "status": "pending",    "steps": [      {        "key": "lofoten",        "name": "Lofoten sea kayaking",        "status": "pending",        "decidedBy": "6650f1c2a9e4b1d2c3f40a30",        "decidedRole": null,        "decidedAt": "2026-11-02T09:30:00.000Z",        "comment": null,        "who": null      }    ],    "message": null,    "reviewers": [      "…"    ],    "publishOnApproval": true,    "submittedBy": "Ingrid Berg",    "sentByAgent": null,    "draftedByAi": null,    "submittedAt": "2026-11-02T09:30:00.000Z",    "decidedAt": "2026-11-02T09:30:00.000Z",    "publishedAt": "2026-11-02T09:30:00.000Z",    "stale": false  }}

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.

Review

  • idstring

    An id.

  • contentIdstring

    An id.

  • contentNamestring

  • contentUrlstring or null

  • contentTypestring

  • regionstring or null

  • localestring or null

  • environmentIdstring

    An id.

  • regionIdstring

    An id.

  • localeIdstring

    An id.

  • versioninteger

    The draft version sent.

  • statusstring

    One of pending, approved, rejected, withdrawn, superseded.
  • stepsobject[]

    Fields of steps
    • keystring

    • namestring

    • statusstring

      One of pending, approved, rejected.
    • decidedBystring or null

    • decidedRolestring or null

    • decidedAtstring or null

    • commentstring or null

    • whostring or null

  • messagestring or null

  • reviewersstring[]

  • publishOnApprovalboolean

  • submittedBystring

  • sentByAgentstring or null

  • draftedByAistring or null

  • submittedAtstring

  • decidedAtstring or null

  • publishedAtstring or null

  • staleboolean

    The page changed after it was sent.