Skip to content

Connected satellites

Connected satellites in the management API. 24 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.

Reads the booking Orbit connection: { connected, locationId }

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

Reads the booking Orbit connection: { connected, locationId }. Permission: space:update to change.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

Responses

  • 200OKThe connection.
    • dataBookingConnection

      Fields of data
      • reachableboolean

        Booking Orbit answered.

      • locationBookingLocation or any or null

        Fields of location

        One of:

        BookingLocation

        • locationIdstring

        • slugstring

        • namestring

        • siteUrlstring or null

        • kindstring

          One of place, online.
        • timeZonestring

        • currencystring

        • logoUrlstring or null

        any or null

      • locationsBookingLocation[]

        Fields of BookingLocation

      • connectionobject or null

        Fields of connection
        • locationIdstring

        • slugstring

        • locationNamestring

        • siteUrlstring

        • connectedAtstring

        • connectedBystring or null

      • canManageboolean

  • 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 space:update to change.
    • 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/booking' \  -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": {    "reachable": true,    "location": {      "locationId": "6650f1c2a9e4b1d2c3f40a5a",      "slug": "lofoten-sea-kayaking",      "name": "Lofoten sea kayaking",      "siteUrl": "https://northwilds.com",      "kind": "place",      "timeZone": "Europe/Oslo",      "currency": "NOK",      "logoUrl": null    },    "locations": [      {        "locationId": "6650f1c2a9e4b1d2c3f40a5a",        "slug": "lofoten-sea-kayaking",        "name": "Lofoten sea kayaking",        "siteUrl": "https://northwilds.com",        "kind": "place",        "timeZone": "Europe/Oslo",        "currency": "NOK",        "logoUrl": null      }    ],    "connection": {      "locationId": "6650f1c2a9e4b1d2c3f40a5a",      "slug": "lofoten-sea-kayaking",      "locationName": "…",      "siteUrl": "https://northwilds.com",      "connectedAt": "2026-11-02T09:30:00.000Z",      "connectedBy": "6650f1c2a9e4b1d2c3f40a30"    },    "canManage": true  }}

Changes the booking Orbit connection: { connected, locationId }

PUT/organisations/{organisationId}/spaces/{spaceId}/bookingKey required

Changes the booking Orbit connection: { connected, locationId }. Permission: space:update to change.

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

  • connectedbooleanrequired

  • locationIdstringoptional

    Which location the space shows. Needed when the organisation has more than one.

    Up to 80 characters.

Responses

  • 200OKThe connection.
    • dataBookingConnection

      Fields of data
      • reachableboolean

        Booking Orbit answered.

      • locationBookingLocation or any or null

        Fields of location

        One of:

        BookingLocation

        • locationIdstring

        • slugstring

        • namestring

        • siteUrlstring or null

        • kindstring

          One of place, online.
        • timeZonestring

        • currencystring

        • logoUrlstring or null

        any or null

      • locationsBookingLocation[]

        Fields of BookingLocation

      • connectionobject or null

        Fields of connection
        • locationIdstring

        • slugstring

        • locationNamestring

        • siteUrlstring

        • connectedAtstring

        • connectedBystring or null

      • canManageboolean

  • 400Bad requestThe body isn't valid JSON. Or booking Orbit could not be reached, or no location to connect.
    • 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 space:update to change, 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.

  • 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 PUT 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/booking' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"connected":true,"locationId":"loc_tromso"}'

Try it

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

Example answer

200 OKJSON
{  "data": {    "reachable": true,    "location": {      "locationId": "6650f1c2a9e4b1d2c3f40a5a",      "slug": "lofoten-sea-kayaking",      "name": "Lofoten sea kayaking",      "siteUrl": "https://northwilds.com",      "kind": "place",      "timeZone": "Europe/Oslo",      "currency": "NOK",      "logoUrl": null    },    "locations": [      {        "locationId": "6650f1c2a9e4b1d2c3f40a5a",        "slug": "lofoten-sea-kayaking",        "name": "Lofoten sea kayaking",        "siteUrl": "https://northwilds.com",        "kind": "place",        "timeZone": "Europe/Oslo",        "currency": "NOK",        "logoUrl": null      }    ],    "connection": {      "locationId": "6650f1c2a9e4b1d2c3f40a5a",      "slug": "lofoten-sea-kayaking",      "locationName": "…",      "siteUrl": "https://northwilds.com",      "connectedAt": "2026-11-02T09:30:00.000Z",      "connectedBy": "6650f1c2a9e4b1d2c3f40a30"    },    "canManage": true  }}

Booking Orbit services

GET/organisations/{organisationId}/spaces/{spaceId}/booking/servicesKey required

Booking Orbit services. A satellite that is not connected answers 400. Permission: Space access.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

  • localestringquery

    The language to list in, such as nb-NO. Leave it out for the satellite's default.

Responses

  • 200OKList.
    • dataobject[]

      Fields of data
      • idstring

      • namestring

      • summarystring

      • imagestring or null

      • durationMinutesinteger

      • pricenumber or null

      • priceKindstring

      • currencystring

      • onlineboolean

  • 400Bad requestThe satellite is not connected to this space, or could not be reached.
    • 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 Space 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.

  • 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/booking/services' \  -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",      "name": "Lofoten sea kayaking",      "summary": "Six days of paddling between the peaks of Lofoten.",      "image": null,      "durationMinutes": 1,      "price": 1,      "priceKind": "…",      "currency": "NOK",      "online": false    }  ]}

Booking Orbit people

GET/organisations/{organisationId}/spaces/{spaceId}/booking/staffKey required

Booking Orbit people. A satellite that is not connected answers 400. Permission: Space access.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

Responses

  • 200OKList.
    • dataobject[]

      Fields of data
      • idstring

      • namestring

      • titlestring or null

      • photostring or null

  • 400Bad requestThe satellite is not connected to this space, or could not be reached.
    • 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 Space 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.

  • 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/booking/staff' \  -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",      "name": "Lofoten sea kayaking",      "title": "Lofoten sea kayaking",      "photo": null    }  ]}

Reads the careers Orbit connection: { connected }

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

Reads the careers Orbit connection: { connected }. Permission: space:update to change.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

Responses

  • 200OKThe connection.
    • dataCareersConnection

      Fields of data
      • reachableboolean

      • siteobject or null

        Fields of site
        • slugstring

        • namestring

        • siteUrlstring

        • logoUrlstring or null

        • languagesstring[]

        • defaultLanguagestring

      • connectionobject or null

        Fields of connection
        • siteSlugstring

        • namestring

        • siteUrlstring

        • connectedAtstring

        • connectedBystring or null

      • canManageboolean

  • 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 space:update to change.
    • 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/careers' \  -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": {    "reachable": true,    "site": {      "slug": "lofoten-sea-kayaking",      "name": "Lofoten sea kayaking",      "siteUrl": "https://northwilds.com",      "logoUrl": null,      "languages": [        "…"      ],      "defaultLanguage": "…"    },    "connection": {      "siteSlug": "…",      "name": "Lofoten sea kayaking",      "siteUrl": "https://northwilds.com",      "connectedAt": "2026-11-02T09:30:00.000Z",      "connectedBy": "6650f1c2a9e4b1d2c3f40a30"    },    "canManage": true  }}

Changes the careers Orbit connection: { connected }

PUT/organisations/{organisationId}/spaces/{spaceId}/careersKey required

Changes the careers Orbit connection: { connected }. Permission: space:update to change.

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

  • connectedbooleanrequired

Responses

  • 200OKThe connection.
    • dataCareersConnection

      Fields of data
      • reachableboolean

      • siteobject or null

        Fields of site
        • slugstring

        • namestring

        • siteUrlstring

        • logoUrlstring or null

        • languagesstring[]

        • defaultLanguagestring

      • connectionobject or null

        Fields of connection
        • siteSlugstring

        • namestring

        • siteUrlstring

        • connectedAtstring

        • connectedBystring or null

      • canManageboolean

  • 400Bad requestThe body isn't valid JSON. Or careers Orbit could not be reached, or the organisation has no career site.
    • 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 space:update to change, 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.

  • 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 PUT 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/careers' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"connected":true}'

Try it

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

Example answer

200 OKJSON
{  "data": {    "reachable": true,    "site": {      "slug": "lofoten-sea-kayaking",      "name": "Lofoten sea kayaking",      "siteUrl": "https://northwilds.com",      "logoUrl": null,      "languages": [        "…"      ],      "defaultLanguage": "…"    },    "connection": {      "siteSlug": "…",      "name": "Lofoten sea kayaking",      "siteUrl": "https://northwilds.com",      "connectedAt": "2026-11-02T09:30:00.000Z",      "connectedBy": "6650f1c2a9e4b1d2c3f40a30"    },    "canManage": true  }}

Careers Orbit job filters

GET/organisations/{organisationId}/spaces/{spaceId}/careers/filtersKey required

Careers Orbit job filters. A satellite that is not connected answers 400. Permission: Space access.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

  • localestringquery

    The language to list in, such as nb-NO. Leave it out for the satellite's default.

Responses

  • 200OKList.
    • dataany

      The career site's job filters, such as departments and locations, as Careers Orbit answers them.

  • 400Bad requestThe satellite is not connected to this space, or could not be reached.
    • 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 Space 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.

  • 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/careers/filters' \  -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": null}

Careers Orbit jobs, up to 100

GET/organisations/{organisationId}/spaces/{spaceId}/careers/jobsKey required

Careers Orbit jobs, up to 100. A satellite that is not connected answers 400. Permission: Space access.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

  • localestringquery

    The language to list in, such as nb-NO. Leave it out for the satellite's default.

Responses

  • 200OKList.
    • dataobject[]

      Fields of data
      • idstring

      • namestring

      • metastring

        Such as Tromsø · Full time.

  • 400Bad requestThe satellite is not connected to this space, or could not be reached.
    • 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 Space 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.

  • 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/careers/jobs' \  -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",      "name": "Lofoten sea kayaking",      "meta": "…"    }  ]}

Reads the commerce Orbit connection: { connected, storeSlug }

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

Reads the commerce Orbit connection: { connected, storeSlug }. Permission: space:update to change.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

Responses

  • 200OKThe connection.
    • dataCommerceConnection

      Fields of data
      • reachableboolean

      • storeCommerceStore or any or null

        Fields of store

        One of:

        CommerceStore

        • shopIdstring

        • storeSlugstring

        • brandNamestring

        • siteUrlstring

        • localesstring[]

        • defaultLocalestring

        • currencystring

        • currenciesstring[]

        any or null

      • storesCommerceStore[]

        Fields of CommerceStore

      • connectionobject or null

        Fields of connection
        • storeSlugstring

        • brandNamestring

        • siteUrlstring

        • connectedAtstring

        • connectedBystring or null

      • canManageboolean

  • 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 space:update to change.
    • 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/commerce' \  -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": {    "reachable": true,    "store": {      "shopId": "6650f1c2a9e4b1d2c3f40a56",      "storeSlug": "…",      "brandName": "Northwilds",      "siteUrl": "https://northwilds.com",      "locales": [        "nb-NO"      ],      "defaultLocale": "…",      "currency": "NOK",      "currencies": [        "…"      ]    },    "stores": [      {        "shopId": "6650f1c2a9e4b1d2c3f40a56",        "storeSlug": "…",        "brandName": "Northwilds",        "siteUrl": "https://northwilds.com",        "locales": [          "nb-NO"        ],        "defaultLocale": "…",        "currency": "NOK",        "currencies": [          "…"        ]      }    ],    "connection": {      "storeSlug": "…",      "brandName": "Northwilds",      "siteUrl": "https://northwilds.com",      "connectedAt": "2026-11-02T09:30:00.000Z",      "connectedBy": "6650f1c2a9e4b1d2c3f40a30"    },    "canManage": true  }}

Changes the commerce Orbit connection: { connected, storeSlug }

PUT/organisations/{organisationId}/spaces/{spaceId}/commerceKey required

Changes the commerce Orbit connection: { connected, storeSlug }. Permission: space:update to change.

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

  • connectedbooleanrequired

  • storeSlugstringoptional

    Which shop the space shows. Needed when the organisation has more than one.

    Up to 80 characters.

Responses

  • 200OKThe connection.
    • dataCommerceConnection

      Fields of data
      • reachableboolean

      • storeCommerceStore or any or null

        Fields of store

        One of:

        CommerceStore

        • shopIdstring

        • storeSlugstring

        • brandNamestring

        • siteUrlstring

        • localesstring[]

        • defaultLocalestring

        • currencystring

        • currenciesstring[]

        any or null

      • storesCommerceStore[]

        Fields of CommerceStore

      • connectionobject or null

        Fields of connection
        • storeSlugstring

        • brandNamestring

        • siteUrlstring

        • connectedAtstring

        • connectedBystring or null

      • canManageboolean

  • 400Bad requestThe body isn't valid JSON. Or commerce Orbit could not be reached, or no shop to connect.
    • 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 space:update to change, 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.

  • 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 PUT 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/commerce' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"connected":true,"storeSlug":"northwilds"}'

Try it

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

Example answer

200 OKJSON
{  "data": {    "reachable": true,    "store": {      "shopId": "6650f1c2a9e4b1d2c3f40a56",      "storeSlug": "…",      "brandName": "Northwilds",      "siteUrl": "https://northwilds.com",      "locales": [        "nb-NO"      ],      "defaultLocale": "…",      "currency": "NOK",      "currencies": [        "…"      ]    },    "stores": [      {        "shopId": "6650f1c2a9e4b1d2c3f40a56",        "storeSlug": "…",        "brandName": "Northwilds",        "siteUrl": "https://northwilds.com",        "locales": [          "nb-NO"        ],        "defaultLocale": "…",        "currency": "NOK",        "currencies": [          "…"        ]      }    ],    "connection": {      "storeSlug": "…",      "brandName": "Northwilds",      "siteUrl": "https://northwilds.com",      "connectedAt": "2026-11-02T09:30:00.000Z",      "connectedBy": "6650f1c2a9e4b1d2c3f40a30"    },    "canManage": true  }}

Commerce Orbit collections

GET/organisations/{organisationId}/spaces/{spaceId}/commerce/collectionsKey required

Commerce Orbit collections. A satellite that is not connected answers 400. Permission: Space access.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

  • localestringquery

    The language to list in, such as nb-NO. Leave it out for the satellite's default.

Responses

  • 200OKList.
    • dataobject[]

      Fields of data
      • idstring

      • namestring

      • imagestring or null

      • productCountinteger

  • 400Bad requestThe satellite is not connected to this space, or could not be reached.
    • 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 Space 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.

  • 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/commerce/collections' \  -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",      "name": "Lofoten sea kayaking",      "image": null,      "productCount": 4    }  ]}

Commerce Orbit products, up to 250; query to search

GET/organisations/{organisationId}/spaces/{spaceId}/commerce/productsKey required

Commerce Orbit products, up to 250; query to search. A satellite that is not connected answers 400. Permission: Space access.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

  • localestringquery

    The language to list in, such as nb-NO. Leave it out for the satellite's default.

  • querystringquery

    Only products matching this text.

Responses

  • 200OKList.
    • dataobject[]

      Up to 250.

      Fields of data
      • idstring

      • namestring

      • summarystring

      • imagestring or null

      • pricenumber or null

      • currencystring

      • availableboolean

      • stockinteger or null

      • variantsinteger

  • 400Bad requestThe satellite is not connected to this space, or could not be reached.
    • 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 Space 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.

  • 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/commerce/products' \  -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",      "name": "Lofoten sea kayaking",      "summary": "Six days of paddling between the peaks of Lofoten.",      "image": null,      "price": 1,      "currency": "NOK",      "available": false,      "stock": 1,      "variants": 1    }  ]}

Products from the organisation's Shopify shop, up to 25; q to search

GET/organisations/{organisationId}/spaces/{spaceId}/shopify/productsKey required

Products from the organisation's Shopify shop, up to 25; q to search. Answers 400 when Shopify isn't connected in Orbit or the plan is below Growth. Permission: content:read.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

  • qstringquery

    Only products matching this text, such as a title or a tag.

Responses

  • 200OKList.
    • dataobject[]

      Up to 25, the best matches first, or by title without q.

      Fields of data
      • idstring

        Shopify's id, such as gid://shopify/Product/7982301462741.

      • handlestring

        Such as arctic-down-jacket.

      • titlestring

      • priceRangeobject

        Fields of priceRange
        • minobject

          Fields of min
          • amountstring

            A decimal string, such as 249.0.

          • currencyCodestring

            Such as NOK.

        • maxobject

          Fields of max
          • amountstring

            A decimal string, such as 249.0.

          • currencyCodestring

            Such as NOK.

      • imageobject or null

        Fields of image
        • urlstring

        • altTextstring or null

        • widthinteger or null

        • heightinteger or null

      • urlstring

        The product's page in the shop.

  • 400Bad requestShopify isn't connected in Orbit, the plan is below Growth, or Shopify didn't answer.
    • 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.
    • 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/shopify/products' \  -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",      "handle": "…",      "title": "Lofoten sea kayaking",      "priceRange": {        "min": {          "amount": "…",          "currencyCode": "…"        },        "max": {          "amount": "…",          "currencyCode": "…"        }      },      "image": {        "url": "https://northwilds.com/trips/lofoten-sea-kayaking",        "altText": null,        "width": 1,        "height": 1      },      "url": "https://northwilds.com/trips/lofoten-sea-kayaking"    }  ]}

Removes the insights Orbit site: { site } to link one, or { create: { name, domains } }

DELETE/organisations/{organisationId}/spaces/{spaceId}/insightsKey required

Removes the insights Orbit site: { site } to link one, or { create: { name, domains } }. Permission: space:read; space:update to change.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

Responses

  • 200OKThe connection.
    • dataany or null

      Always 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 space:read; space:update to change, 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.

  • 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/insights' \  -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": null}

Reads the insights Orbit site: { site } to link one, or { create: { name, domains } }

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

Reads the insights Orbit site: { site } to link one, or { create: { name, domains } }. Permission: space:read; space:update to change.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

Responses

  • 200OKThe connection.
    • dataInsightsConnection or any or null

      Fields of data

      One of:

      InsightsConnection

      • linkedobject or null

        The linked Insights Orbit site.

        Fields of linked
        • sitestring

        • namestring

      • sitesobject[]

        Fields of sites
        • sitestring

        • namestring

        • domainsstring[]

        • spacesobject[]

          Fields of spaces
          • spaceIdstring

            An id.

          • namestring

      • canManageboolean

      • canEditboolean

      • suggestionobject

        A name and domains for a new site, from the space's domains.

        Fields of suggestion
        • namestring

        • domainsstring[]

      • reportUrlstring or null

      • errorstring or null

      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 space:read; space:update to change.
    • 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/insights' \  -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": {    "linked": {      "site": "…",      "name": "Lofoten sea kayaking"    },    "sites": [      {        "site": "…",        "name": "Lofoten sea kayaking",        "domains": [          "…"        ],        "spaces": [          {            "spaceId": "6650f1c2a9e4b1d2c3f40a02",            "name": "Lofoten sea kayaking"          }        ]      }    ],    "canManage": true,    "canEdit": true,    "suggestion": {      "name": "Lofoten sea kayaking",      "domains": [        "…"      ]    },    "reportUrl": null,    "error": null  }}

Changes the insights Orbit site: { site } to link one, or { create: { name, domains } }

PUT/organisations/{organisationId}/spaces/{spaceId}/insightsKey required

Changes the insights Orbit site: { site } to link one, or { create: { name, domains } }. Permission: space:read; space:update to change.

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

One of:

object

  • sitestringrequired

    An Insights Orbit site key to link.

object

  • createobjectrequired

    Fields of create
    • namestringrequired

    • domainsstring[]required

      1 to 20 domains, such as northwilds.com.

Responses

  • 200OKThe connection.
    • dataInsightsConnection or any or null

      Fields of data

      One of:

      InsightsConnection

      • linkedobject or null

        The linked Insights Orbit site.

        Fields of linked
        • sitestring

        • namestring

      • sitesobject[]

        Fields of sites
        • sitestring

        • namestring

        • domainsstring[]

        • spacesobject[]

          Fields of spaces
          • spaceIdstring

            An id.

          • namestring

      • canManageboolean

      • canEditboolean

      • suggestionobject

        A name and domains for a new site, from the space's domains.

        Fields of suggestion
        • namestring

        • domainsstring[]

      • reportUrlstring or null

      • errorstring or null

      any or null

  • 400Bad requestThe body isn't valid JSON. Or insights Orbit is not available to the organisation, or the body is neither { site } nor { create }.
    • 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 space:read; space:update to change, 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.

  • 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/insights' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"create":{"name":"Northwilds","domains":["northwilds.com"]}}'

Try it

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

Example answer

200 OKJSON
{  "data": {    "linked": {      "site": "…",      "name": "Lofoten sea kayaking"    },    "sites": [      {        "site": "…",        "name": "Lofoten sea kayaking",        "domains": [          "…"        ],        "spaces": [          {            "spaceId": "6650f1c2a9e4b1d2c3f40a02",            "name": "Lofoten sea kayaking"          }        ]      }    ],    "canManage": true,    "canEdit": true,    "suggestion": {      "name": "Lofoten sea kayaking",      "domains": [        "…"      ]    },    "reportUrl": null,    "error": null  }}

Reads the presence Orbit connection: { connected }

GET/organisations/{organisationId}/spaces/{spaceId}/presence-orbitKey required

Reads the presence Orbit connection: { connected }. Permission: space:update to change.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

Responses

  • 200OKThe connection.
    • dataPresenceConnection

      Fields of data
      • reachableboolean

      • brandNamestring or null

      • locationsPresenceLocation[]

        Fields of PresenceLocation

      • connectionobject or null

        Fields of connection
        • siteSlugstring

        • brandNamestring

        • connectedAtstring

        • connectedBystring or null

      • canManageboolean

  • 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 space:update to change.
    • 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/presence-orbit' \  -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": {    "reachable": true,    "brandName": "Northwilds",    "locations": [      {        "id": "6650f1c2a9e4b1d2c3f40a50",        "name": "Lofoten sea kayaking",        "slug": "lofoten-sea-kayaking",        "city": "Tromsø",        "average": 1,        "total": 4      }    ],    "connection": {      "siteSlug": "…",      "brandName": "Northwilds",      "connectedAt": "2026-11-02T09:30:00.000Z",      "connectedBy": "6650f1c2a9e4b1d2c3f40a30"    },    "canManage": true  }}

Changes the presence Orbit connection: { connected }

PUT/organisations/{organisationId}/spaces/{spaceId}/presence-orbitKey required

Changes the presence Orbit connection: { connected }. Permission: space:update to change.

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

  • connectedbooleanrequired

Responses

  • 200OKThe connection.
    • dataPresenceConnection

      Fields of data
      • reachableboolean

      • brandNamestring or null

      • locationsPresenceLocation[]

        Fields of PresenceLocation

      • connectionobject or null

        Fields of connection
        • siteSlugstring

        • brandNamestring

        • connectedAtstring

        • connectedBystring or null

      • canManageboolean

  • 400Bad requestThe body isn't valid JSON. Or presence Orbit could not be reached, or the organisation has none.
    • 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 space:update to change, 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.

  • 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 PUT 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/presence-orbit' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"connected":true}'

Try it

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

Example answer

200 OKJSON
{  "data": {    "reachable": true,    "brandName": "Northwilds",    "locations": [      {        "id": "6650f1c2a9e4b1d2c3f40a50",        "name": "Lofoten sea kayaking",        "slug": "lofoten-sea-kayaking",        "city": "Tromsø",        "average": 1,        "total": 4      }    ],    "connection": {      "siteSlug": "…",      "brandName": "Northwilds",      "connectedAt": "2026-11-02T09:30:00.000Z",      "connectedBy": "6650f1c2a9e4b1d2c3f40a30"    },    "canManage": true  }}

Presence Orbit locations with their ratings

GET/organisations/{organisationId}/spaces/{spaceId}/presence-orbit/locationsKey required

Presence Orbit locations with their ratings. A satellite that is not connected answers 400. Permission: Space access.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

Responses

  • 200OKList.
    • dataPresenceLocation[]

      Fields of data
      • idstring

      • namestring

      • slugstring

      • citystring

      • averagenumber or null

        The average rating.

      • totalinteger

        Reviews counted.

  • 400Bad requestThe satellite is not connected to this space, or could not be reached.
    • 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 Space 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.

  • 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/presence-orbit/locations' \  -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": "6650f1c2a9e4b1d2c3f40a50",      "name": "Lofoten sea kayaking",      "slug": "lofoten-sea-kayaking",      "city": "Tromsø",      "average": 1,      "total": 4    }  ]}

Reads the travel Orbit connection: { connected, brandId }

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

Reads the travel Orbit connection: { connected, brandId }. Permission: space:update to change.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

Responses

  • 200OKThe connection.
    • dataTravelConnection

      Fields of data
      • reachableboolean

      • brandsTravelBrand[]

        Fields of TravelBrand

      • siteTravelBrand or any or null

        Fields of site

        One of:

        TravelBrand

        • brandIdstring

        • bookingSlugstring

        • brandNamestring

        • logoUrlstring or nullsometimes

        • siteUrlstring

        • localesstring[]

        • defaultLocalestring

        any or null

      • connectionobject or null

        Fields of connection
        • brandIdstringsometimes

        • bookingSlugstring

        • brandNamestring

        • siteUrlstring

        • connectedAtstring

        • connectedBystring or null

      • canManageboolean

  • 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 space:update to change.
    • 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/travel' \  -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": {    "reachable": true,    "brands": [      {        "brandId": "6650f1c2a9e4b1d2c3f40a57",        "bookingSlug": "…",        "brandName": "Northwilds",        "logoUrl": null,        "siteUrl": "https://northwilds.com",        "locales": [          "nb-NO"        ],        "defaultLocale": "…"      }    ],    "site": {      "brandId": "6650f1c2a9e4b1d2c3f40a57",      "bookingSlug": "…",      "brandName": "Northwilds",      "logoUrl": null,      "siteUrl": "https://northwilds.com",      "locales": [        "nb-NO"      ],      "defaultLocale": "…"    },    "connection": {      "brandId": "6650f1c2a9e4b1d2c3f40a57",      "bookingSlug": "…",      "brandName": "Northwilds",      "siteUrl": "https://northwilds.com",      "connectedAt": "2026-11-02T09:30:00.000Z",      "connectedBy": "6650f1c2a9e4b1d2c3f40a30"    },    "canManage": true  }}

Changes the travel Orbit connection: { connected, brandId }

PUT/organisations/{organisationId}/spaces/{spaceId}/travelKey required

Changes the travel Orbit connection: { connected, brandId }. Permission: space:update to change.

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

  • connectedbooleanrequired

  • brandIdstring or nulloptional

    Which Travel Orbit brand the space shows.

Responses

  • 200OKThe connection.
    • dataTravelConnection

      Fields of data
      • reachableboolean

      • brandsTravelBrand[]

        Fields of TravelBrand

      • siteTravelBrand or any or null

        Fields of site

        One of:

        TravelBrand

        • brandIdstring

        • bookingSlugstring

        • brandNamestring

        • logoUrlstring or nullsometimes

        • siteUrlstring

        • localesstring[]

        • defaultLocalestring

        any or null

      • connectionobject or null

        Fields of connection
        • brandIdstringsometimes

        • bookingSlugstring

        • brandNamestring

        • siteUrlstring

        • connectedAtstring

        • connectedBystring or null

      • canManageboolean

  • 400Bad requestThe body isn't valid JSON. Or travel Orbit could not be reached, or no brand to connect.
    • 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 space:update to change, 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.

  • 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 PUT 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/travel' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"connected":true,"brandId":"northwilds"}'

Try it

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

Example answer

200 OKJSON
{  "data": {    "reachable": true,    "brands": [      {        "brandId": "6650f1c2a9e4b1d2c3f40a57",        "bookingSlug": "…",        "brandName": "Northwilds",        "logoUrl": null,        "siteUrl": "https://northwilds.com",        "locales": [          "nb-NO"        ],        "defaultLocale": "…"      }    ],    "site": {      "brandId": "6650f1c2a9e4b1d2c3f40a57",      "bookingSlug": "…",      "brandName": "Northwilds",      "logoUrl": null,      "siteUrl": "https://northwilds.com",      "locales": [        "nb-NO"      ],      "defaultLocale": "…"    },    "connection": {      "brandId": "6650f1c2a9e4b1d2c3f40a57",      "bookingSlug": "…",      "brandName": "Northwilds",      "siteUrl": "https://northwilds.com",      "connectedAt": "2026-11-02T09:30:00.000Z",      "connectedBy": "6650f1c2a9e4b1d2c3f40a30"    },    "canManage": true  }}

Travel Orbit destinations

GET/organisations/{organisationId}/spaces/{spaceId}/travel/destinationsKey required

Travel Orbit destinations. A satellite that is not connected answers 400. Permission: Space access.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

  • localestringquery

    The language to list in, such as nb-NO. Leave it out for the satellite's default.

Responses

  • 200OKList.
    • dataobject[]

      Fields of data
      • codestring

        Such as NO.

      • namestring

      • kindstring

        One of country, continent.
      • continentstring

      • tripCountinteger

  • 400Bad requestThe satellite is not connected to this space, or could not be reached.
    • 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 Space 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.

  • 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/travel/destinations' \  -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": [    {      "code": "nb-NO",      "name": "Lofoten sea kayaking",      "kind": "country",      "continent": "…",      "tripCount": 4    }  ]}

Travel Orbit guides

GET/organisations/{organisationId}/spaces/{spaceId}/travel/guidesKey required

Travel Orbit guides. A satellite that is not connected answers 400. Permission: Space access.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

  • localestringquery

    The language to list in, such as nb-NO. Leave it out for the satellite's default.

Responses

  • 200OKList.
    • dataobject[]

      Fields of data
      • slugstring

      • namestring

      • rolestring

      • imagestring or null

      • tripCountinteger

  • 400Bad requestThe satellite is not connected to this space, or could not be reached.
    • 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 Space 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.

  • 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/travel/guides' \  -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": [    {      "slug": "lofoten-sea-kayaking",      "name": "Lofoten sea kayaking",      "role": "…",      "image": null,      "tripCount": 4    }  ]}

Travel Orbit trips

GET/organisations/{organisationId}/spaces/{spaceId}/travel/tripsKey required

Travel Orbit trips. A satellite that is not connected answers 400. Permission: Space access.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

  • localestringquery

    The language to list in, such as nb-NO. Leave it out for the satellite's default.

Responses

  • 200OKList.
    • dataobject[]

      Fields of data
      • idstring

      • namestring

      • summarystring

      • imagestring or null

      • daysinteger or null

      • priceFromnumber or null

      • currencystring

      • nextDeparturestring or null

        A date, YYYY-MM-DD.

      • countriesstring[]

      • departuresobject[]

        Fields of departures
        • idstring

        • startDatestring

        • statusstring

        • seatsLeftinteger or null

  • 400Bad requestThe satellite is not connected to this space, or could not be reached.
    • 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 Space 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.

  • 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/travel/trips' \  -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",      "name": "Lofoten sea kayaking",      "summary": "Six days of paddling between the peaks of Lofoten.",      "image": null,      "days": 1,      "priceFrom": 1,      "currency": "NOK",      "nextDeparture": null,      "countries": [        "…"      ],      "departures": [        {          "id": "6650f1c2a9e4b1d2c3f40a40",          "startDate": "…",          "status": "…",          "seatsLeft": 1        }      ]    }  ]}

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.

BookingConnection

  • reachableboolean

    Booking Orbit answered.

  • locationBookingLocation or any or null

    Fields of location

    One of:

    BookingLocation

    • locationIdstring

    • slugstring

    • namestring

    • siteUrlstring or null

    • kindstring

      One of place, online.
    • timeZonestring

    • currencystring

    • logoUrlstring or null

    any or null

  • locationsBookingLocation[]

    Fields of BookingLocation

  • connectionobject or null

    Fields of connection
    • locationIdstring

    • slugstring

    • locationNamestring

    • siteUrlstring

    • connectedAtstring

    • connectedBystring or null

  • canManageboolean

BookingLocation

  • locationIdstring

  • slugstring

  • namestring

  • siteUrlstring or null

  • kindstring

    One of place, online.
  • timeZonestring

  • currencystring

  • logoUrlstring or null

CareersConnection

  • reachableboolean

  • siteobject or null

    Fields of site
    • slugstring

    • namestring

    • siteUrlstring

    • logoUrlstring or null

    • languagesstring[]

    • defaultLanguagestring

  • connectionobject or null

    Fields of connection
    • siteSlugstring

    • namestring

    • siteUrlstring

    • connectedAtstring

    • connectedBystring or null

  • canManageboolean

CommerceConnection

  • reachableboolean

  • storeCommerceStore or any or null

    Fields of store

    One of:

    CommerceStore

    • shopIdstring

    • storeSlugstring

    • brandNamestring

    • siteUrlstring

    • localesstring[]

    • defaultLocalestring

    • currencystring

    • currenciesstring[]

    any or null

  • storesCommerceStore[]

    Fields of CommerceStore

  • connectionobject or null

    Fields of connection
    • storeSlugstring

    • brandNamestring

    • siteUrlstring

    • connectedAtstring

    • connectedBystring or null

  • canManageboolean

CommerceStore

  • shopIdstring

  • storeSlugstring

  • brandNamestring

  • siteUrlstring

  • localesstring[]

  • defaultLocalestring

  • currencystring

  • currenciesstring[]

PresenceConnection

  • reachableboolean

  • brandNamestring or null

  • locationsPresenceLocation[]

    Fields of PresenceLocation

  • connectionobject or null

    Fields of connection
    • siteSlugstring

    • brandNamestring

    • connectedAtstring

    • connectedBystring or null

  • canManageboolean

PresenceLocation

  • idstring

  • namestring

  • slugstring

  • citystring

  • averagenumber or null

    The average rating.

  • totalinteger

    Reviews counted.

TravelConnection

  • reachableboolean

  • brandsTravelBrand[]

    Fields of TravelBrand

  • siteTravelBrand or any or null

    Fields of site

    One of:

    TravelBrand

    • brandIdstring

    • bookingSlugstring

    • brandNamestring

    • logoUrlstring or nullsometimes

    • siteUrlstring

    • localesstring[]

    • defaultLocalestring

    any or null

  • connectionobject or null

    Fields of connection
    • brandIdstringsometimes

    • bookingSlugstring

    • brandNamestring

    • siteUrlstring

    • connectedAtstring

    • connectedBystring or null

  • canManageboolean

InsightsConnection

  • linkedobject or null

    The linked Insights Orbit site.

    Fields of linked
    • sitestring

    • namestring

  • sitesobject[]

    Fields of sites
    • sitestring

    • namestring

    • domainsstring[]

    • spacesobject[]

      Fields of spaces
      • spaceIdstring

        An id.

      • namestring

  • canManageboolean

  • canEditboolean

  • suggestionobject

    A name and domains for a new site, from the space's domains.

    Fields of suggestion
    • namestring

    • domainsstring[]

  • reportUrlstring or null

  • errorstring or null

TravelBrand

  • brandIdstring

  • bookingSlugstring

  • brandNamestring

  • logoUrlstring or nullsometimes

  • siteUrlstring

  • localesstring[]

  • defaultLocalestring