CMS Orbit delivery API
Read published content: pages, lists, menus, globals, campaigns, flags, sitemaps and the content model.
The delivery API is how a website reads published content. It is read only, and every endpoint answers with JSON in data. Errors come as error with a code and a message.
Send a delivery key with every request, in Authorization: Bearer or x-api-key. A public key (cms_pk_) may also go in the address as apiKey, so our CDN can cache the answer close to your visitors. A secret key (cms_sk_) reads drafts with draft=true and only works from a server: sent from another website's browser it is refused with 401.
Leave the trailing slash off endpoint addresses. Each key may make 60,000 requests a minute and each visitor's IP address 15,000. Answers carry X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (seconds until the minute starts again); over the limit the answer is 429 with Retry-After.
Lists are paged with page and perPage, and answer with total, page and hasMore.
Read the guideOpenAPI 3.1 document
Try it settings
https://api.bifrostorbit.com/cms/v1
Every request needs a delivery key. Paste a public key (cms_pk_) from Configuration › API keys in CMS Orbit, for the environment you call.
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.
PagesPages by their address, with fallback and redirects.
Resolve an address
GET/resolveKey required
Says what an address is: a page, a redirect, gone or not found. Call it before rendering a page, so redirects and removed pages behave correctly. Optional header x-cms-referrer: the page that linked here, recorded with addresses that are not found.
Parameters
urlstringqueryThe page address. A missing leading slash is added and a trailing slash removed.
Default "/".regionstringqueryRegion key or short code, such as germany or de. The space's first region unless you say.
localestringqueryLanguage code, such as de-DE. The region's default language unless you say.
strictstringquerytrue refuses every fallback: the page must exist in the language and region asked for.
Only true.draftstringquerytrue reads drafts instead of published content. Needs a secret key, from a server.
Only true.includestringqueryExtra content, separated by commas: references.
Responses
200OKA page or a redirect.dataResolvedWhat an address is. The HTTP status follows kind.
Fields of data
One of:
object
kind"page"pagePageA published page, or its draft.
object
kind"redirect"destinationstringWhere to send the visitor.
statusCodeintegerSuch as 301.
permanentbooleantrue for 301 and 308.
hopsintegerRedirects followed to reach the final address.
object
kind"gone"
object
kind"notFound"
400Bad requestAn include other than fields or references.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
401UnauthorisedNo key, an unknown, deleted or expired key, a public key asking for drafts, a secret key from a browser, or a region or language the key may not read.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
402Payment requiredThe organisation's plan has ended, so delivery is paused.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
404Not foundNothing was ever published here.dataResolvedWhat an address is. The HTTP status follows kind.
Fields of data
One of:
object
kind"page"pagePageA published page, or its draft.
object
kind"redirect"destinationstringWhere to send the visitor.
statusCodeintegerSuch as 301.
permanentbooleantrue for 301 and 308.
hopsintegerRedirects followed to reach the final address.
object
kind"gone"
object
kind"notFound"
410GonePublished once and removed, or a campaign page that has ended.dataResolvedWhat an address is. The HTTP status follows kind.
Fields of data
One of:
object
kind"page"pagePageA published page, or its draft.
object
kind"redirect"destinationstringWhere to send the visitor.
statusCodeintegerSuch as 301.
permanentbooleantrue for 301 and 308.
hopsintegerRedirects followed to reach the final address.
object
kind"gone"
object
kind"notFound"
429Too many requestsToo many requests this minute. Retry-After says how many seconds to wait.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
500Server errorSomething went wrong on our side. Try again in a moment.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
curl 'https://api.bifrostorbit.com/cms/v1/resolve' \ -H 'Authorization: Bearer cms_pk_…'Try it
Paste a public key above first.
Example answer
{ "data": { "kind": "redirect", "destination": "/gear/fjell-gtx-boot", "statusCode": 301, "permanent": true, "hops": 1 }}Get a page
GET/contentKey required
One page by its address. Use it when you only need the page and handle redirects yourself. It follows the language and region fallback unless strict=true.
Parameters
urlstringqueryThe page address. A missing leading slash is added and a trailing slash removed.
Default "/".regionstringqueryRegion key or short code, such as germany or de. The space's first region unless you say.
localestringqueryLanguage code, such as de-DE. The region's default language unless you say.
strictstringquerytrue refuses every fallback: the page must exist in the language and region asked for.
Only true.draftstringquerytrue reads drafts instead of published content. Needs a secret key, from a server.
Only true.includestringqueryExtra content, separated by commas: references.
Responses
200OKThe page.dataPageA published page, or its draft.
Fields of data
idstringThe entry's id in this region and language, the same as in the management API.
urlstringSuch as /gear/fjell-gtx-boot.
namestringcontentTypestringlocalestringThe language that answered.
regionstringThe region that answered.
requestedLocalestringWhat was asked for, or the default.
requestedRegionstringWhat was asked for, or the default.
fallbackAppliedbooleanAnother language answered.
regionFallbackAppliedbooleanAnother region answered.
draftbooleanpublishedAtstring or nullWhen it was last published.
versionintegerThe published version, or the draft version for a draft.
fieldsmap of anyThe content type's fields. Images become Image objects and links carry the target page's current address. See https://docs.bifrostorbit.com/cms/developers/field-types/.
componentsComponent[]The page body.
seoSeoReady-made metadata for the page.
insightsobject or nullFields of insights
sitestringThe Insights Orbit site key, public like the script tag.
expiredobjectsometimesOnly on a campaign page past its end date that is set to stay visible.
Fields of expired
messagestringSuch as This offer has ended.
travelanysometimesOn a Travel Orbit page: kind (trip, destination or guide), slug and the item under that name. See https://docs.bifrostorbit.com/cms/developers/travel-pages/.
experimentsanysometimesOn a page with a running experiment: collect, assignment, tests and goals. See https://docs.bifrostorbit.com/cms/developers/experiments/.
400Bad requestAn include other than fields or references.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
401UnauthorisedNo key, an unknown, deleted or expired key, a public key asking for drafts, a secret key from a browser, or a region or language the key may not read.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
402Payment requiredThe organisation's plan has ended, so delivery is paused.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
404Not foundNothing at the address.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
429Too many requestsToo many requests this minute. Retry-After says how many seconds to wait.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
500Server errorSomething went wrong on our side. Try again in a moment.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
curl 'https://api.bifrostorbit.com/cms/v1/content' \ -H 'Authorization: Bearer cms_pk_…'Try it
Paste a public key above first.
Example answer
{ "data": { "id": "6650f1c2a9e4b1d2c3f40a21", "url": "/trips/lofoten-sea-kayaking", "name": "Lofoten sea kayaking", "contentType": "trip", "locale": "en-GB", "region": "norway", "requestedLocale": "en-GB", "requestedRegion": "norway", "fallbackApplied": false, "regionFallbackApplied": false, "draft": false, "publishedAt": "2026-11-02T09:30:00.000Z", "version": 7, "fields": { "title": "Lofoten sea kayaking", "days": 6, "heroImage": { "id": "6650f1c2a9e4b1d2c3f40a40", "url": "https://media.northwilds.com/lofoten-kayaks.webp", "mimeType": "image/webp", "width": 2400, "height": 1600, "alt": "Kayaks on a calm fjord in Lofoten", "title": null, "subtitles": null, "focalPoint": { "x": 0.5, "y": 0.6 } } }, "components": [ { "id": "hero-1", "type": "hero", "schemaVersion": 1, "fields": { "heading": "Paddle the Lofoten fjords" }, "children": {}, "variant": null } ], "seo": { "title": "Lofoten sea kayaking | Northwilds", "description": "Six days paddling between the peaks of Lofoten, with a guide and camps on quiet beaches.", "canonical": "https://northwilds.com/trips/lofoten-sea-kayaking", "robots": { "index": true, "follow": true }, "openGraph": { "type": "website", "title": "Lofoten sea kayaking", "description": "Six days paddling between the peaks of Lofoten.", "url": "https://northwilds.com/trips/lofoten-sea-kayaking", "siteName": "Northwilds", "locale": "en_GB", "image": { "url": "https://media.northwilds.com/lofoten-kayaks.webp", "width": 1200, "height": 630, "alt": "Kayaks on a calm fjord in Lofoten" } }, "twitter": { "card": "summary_large_image", "site": null, "title": "Lofoten sea kayaking", "description": "Six days paddling between the peaks of Lofoten.", "image": { "url": "https://media.northwilds.com/lofoten-kayaks.webp", "width": 1200, "height": 630, "alt": "Kayaks on a calm fjord in Lofoten" } }, "verification": { "google": null, "bing": null }, "alternates": [ { "hreflang": "en-GB", "href": "https://northwilds.com/trips/lofoten-sea-kayaking" }, { "hreflang": "nb-NO", "href": "https://northwilds.com/no/turer/lofoten-havpadling" } ], "breadcrumbs": [ { "name": "Trips", "url": "https://northwilds.com/trips" }, { "name": "Lofoten sea kayaking", "url": "https://northwilds.com/trips/lofoten-sea-kayaking" } ], "jsonLd": [] }, "insights": null }}ListsEntries of one content type.
List entries
GET/listKey required
Entries of one content type, such as products, articles or FAQ entries. Items are summaries without a body. Add include=fields for each entry's fields too. Filter with filter[<field>]=<value>, such as filter[activity]=hiking: exact matches, repeat for several fields. Lists don't fall back to another language.
Parameters
typestringqueryContent type key, such as product. Required in practice: without it the list is empty.
pageintegerquery1 or more.
Default 1. At least 1.perPageintegerquery1 to 100, 20 unless you say. Larger values are capped at 100.
Default 20. At least 1. At most 100.sortstringquerysortOrder (the editors' order, the default), name, -name, publishedAt, -publishedAt, updatedAt or -updatedAt.
One of sortOrder, name, -name, publishedAt, -publishedAt, updatedAt, -updatedAt.tagstringqueryEntries whose tags field contains this.
categorystringqueryEntries whose category field equals this.
qstringqueryEntries whose name contains this text, ignoring case.
regionstringqueryRegion key or short code, such as germany or de. The space's first region unless you say.
localestringqueryLanguage code, such as de-DE. The region's default language unless you say.
draftstringquerytrue reads drafts instead of published content. Needs a secret key, from a server.
Only true.includestringqueryExtra content, separated by commas: fields, references (which implies fields).
Responses
200OKA page of entries. Ask for the next page while hasMore is true.dataListFields of data
itemsEntry[]totalintegerMatching entries across all pages.
pageintegerhasMorebooleanAsk for the next page while true.
400Bad requestAn unknown sort, a filter name that isn't a valid field key, or an unknown include.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
401UnauthorisedNo key, an unknown, deleted or expired key, a public key asking for drafts, a secret key from a browser, or a region or language the key may not read.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
402Payment requiredThe organisation's plan has ended, so delivery is paused.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
404Not foundNo region or language with that key, or the space has no region yet. The message says which, such as Region not found.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
429Too many requestsToo many requests this minute. Retry-After says how many seconds to wait.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
500Server errorSomething went wrong on our side. Try again in a moment.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
curl 'https://api.bifrostorbit.com/cms/v1/list' \ -H 'Authorization: Bearer cms_pk_…'Try it
Paste a public key above first.
Example answer
{ "data": { "items": [ { "id": "6650f1c2a9e4b1d2c3f40a21", "url": "/trips/lofoten-sea-kayaking", "name": "Lofoten sea kayaking", "contentType": "trip", "publishedAt": "2026-11-02T09:30:00.000Z" }, { "id": "6650f1c2a9e4b1d2c3f40a22", "url": "/trips/jotunheimen-hut-to-hut", "name": "Jotunheimen hut to hut", "contentType": "trip", "publishedAt": "2026-10-28T14:05:00.000Z" } ], "total": 14, "page": 1, "hasMore": true }}SearchSearch by meaning and related entries, with Gravity.
Search by meaning
GET/searchKey required
Entries found by what they mean and by their words (hybrid, the default), by meaning only (semantic) or by words only (keyword), with Gravity. A query in one language finds entries in another. Each entry appears once, in the language asked for when it has one, following the language fallback unless strict=true. The visibility rules are the same as for pages: drafts only with a secret key and draft=true, nothing in the bin or before a campaign starts. When Gravity is off for the environment or can't be reached, the answer has keyword results and gravity.fallback is true.
Parameters
qstringquery, requiredWhat to look for, 2 to 200 characters.
modestringqueryhybrid (the default), semantic or keyword.
One of hybrid, semantic, keyword.typestringqueryContent type keys, separated by commas, such as gear,journalPost.
tagstringqueryEntries whose tags field contains one of these, separated by commas.
pathstringqueryOnly entries at this address or below it, such as /gear.
limitintegerquery1 to 50, 10 unless you say.
Default 10. At least 1. At most 50.offsetintegerqueryEntries to skip, 0 to 200.
Default 0. At least 0. At most 200.regionstringqueryRegion key or short code, such as germany or de. The space's first region unless you say.
localestringqueryLanguage code, such as de-DE, or several separated by commas. The region's default language unless you say.
strictstringquerytrue refuses every fallback: the page must exist in the language and region asked for.
Only true.draftstringquerytrue reads drafts instead of published content. Needs a secret key, from a server.
Only true.
Responses
200OKThe entries, best first.dataSearchResultFields of data
itemsSearchItem[]totalintegerEntries found. Search looks only at the closest matches, so this is not a count of every entry that mentions the words.
hasMorebooleangravityobjectFields of gravity
modestringHow the answer was found.
One of hybrid, semantic, keyword.fallbackbooleantrue when Gravity is off or can't be reached, and the answer has keyword results instead.
reasonstringsometimesWhy it fell back.
One of off, unavailable, busy, not_indexed.
400Bad requestNo q, a q over 200 characters or an unknown mode.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
401UnauthorisedNo key, an unknown, deleted or expired key, a public key asking for drafts, a secret key from a browser, or a region or language the key may not read.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
402Payment requiredThe organisation's plan has ended, so delivery is paused.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
404Not foundNo region or language with that key, or the space has no region yet. The message says which, such as Region not found.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
429Too many requestsToo many requests this minute. Retry-After says how many seconds to wait.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
500Server errorSomething went wrong on our side. Try again in a moment.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
curl 'https://api.bifrostorbit.com/cms/v1/search?q=warm%20clothes%20for%20winter' \ -H 'Authorization: Bearer cms_pk_…'Try it
Paste a public key above first.
Example answer
{ "data": { "items": [ { "id": "6650f1c2a9e4b1d2c3f40a31", "url": "/journal/layering-for-winter", "slug": "layering-for-winter", "name": "Layering for winter: stay warm without sweating", "contentType": "journalPost", "locale": "en", "score": 0.0328, "snippet": "How to layer for winter hiking and snowshoeing so you stay warm without sweating…", "fallbackApplied": false }, { "id": "6650f1c2a9e4b1d2c3f40a32", "url": "/gear/loft-down-jacket", "slug": "loft-down-jacket", "name": "Loft down jacket", "contentType": "gear", "locale": "en", "score": 0.0317, "snippet": "A warm, light down jacket with 700 fill power certified down…", "fallbackApplied": false } ], "total": 2, "hasMore": false, "gravity": { "mode": "hybrid", "fallback": false } }}Site-wide contentGlobals, menus, regions, taxonomies and the content model.
Get a global entry
GET/globalKey required
A global entry, such as the footer, by its key. It follows the language fallback, but not the region fallback.
Parameters
keystringquery, requiredThe global entry's key.
regionstringqueryRegion key or short code, such as germany or de. The space's first region unless you say.
localestringqueryLanguage code, such as de-DE. The region's default language unless you say.
strictstringquerytrue refuses every fallback: the page must exist in the language and region asked for.
Only true.draftstringquerytrue reads drafts instead of published content. Needs a secret key, from a server.
Only true.includestringqueryExtra content, separated by commas: references.
Responses
200OKThe entry.dataGlobalFields of data
keystringnamestringcontentTypestringlocalestringThe language that answered, which may be a fallback.
fieldsmap of anycomponentsComponent[]
400Bad requestAn include other than fields or references.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
401UnauthorisedNo key, an unknown, deleted or expired key, a public key asking for drafts, a secret key from a browser, or a region or language the key may not read.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
402Payment requiredThe organisation's plan has ended, so delivery is paused.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
404Not foundNo global entry with that key.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
429Too many requestsToo many requests this minute. Retry-After says how many seconds to wait.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
500Server errorSomething went wrong on our side. Try again in a moment.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
curl 'https://api.bifrostorbit.com/cms/v1/global?key=footer' \ -H 'Authorization: Bearer cms_pk_…'Try it
Paste a public key above first.
Example answer
{ "data": { "key": "footer", "name": "Footer", "contentType": "footer", "locale": "de-DE", "fields": { "copyright": "© Northwilds" }, "components": [] }}List regions
GET/regionsKey required
The regions the key may read, with their languages.
Responses
200OKThe regions.dataRegion[]Fields of data
keystringSuch as germany.
namestringlocalesobject[]Fields of locales
codestringSuch as de-DE.
namestringisDefaultboolean
401UnauthorisedNo key, an unknown, deleted or expired key, a public key asking for drafts, a secret key from a browser, or a region or language the key may not read.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
402Payment requiredThe organisation's plan has ended, so delivery is paused.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
429Too many requestsToo many requests this minute. Retry-After says how many seconds to wait.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
500Server errorSomething went wrong on our side. Try again in a moment.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
curl 'https://api.bifrostorbit.com/cms/v1/regions' \ -H 'Authorization: Bearer cms_pk_…'Try it
Paste a public key above first.
Example answer
{ "data": [ { "key": "germany", "name": "Germany", "locales": [ { "code": "de-DE", "name": "German (Germany)", "isDefault": true }, { "code": "en-DE", "name": "English", "isDefault": false } ] } ]}Get a taxonomy
GET/taxonomies/{key}Key required
A taxonomy and its terms, in their set order.
Parameters
keystringpath, requiredThe taxonomy's key.
regionstringqueryRegion key or short code, such as germany or de. Terms hidden in the region are left out, and its own labels win. The space's first region unless you say.
localestringqueryLanguage for the term labels. A term without a label in it uses the language's fallback, then its default label.
Responses
200OKThe taxonomy.dataTaxonomyFields of data
keystringnamestringregionstring or nullThe region the labels and hidden terms follow, or null when the space has none.
termsobject[]Fields of terms
valuestringlabelstringsortOrderinteger
401UnauthorisedNo key, an unknown, deleted or expired key, a public key asking for drafts, a secret key from a browser, or a region or language the key may not read.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
402Payment requiredThe organisation's plan has ended, so delivery is paused.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
404Not foundNo taxonomy, or no region, with that key.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
429Too many requestsToo many requests this minute. Retry-After says how many seconds to wait.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
500Server errorSomething went wrong on our side. Try again in a moment.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
curl 'https://api.bifrostorbit.com/cms/v1/taxonomies/activity' \ -H 'Authorization: Bearer cms_pk_…'Try it
Paste a public key above first.
Example answer
{ "data": { "key": "activity", "name": "Activity", "region": "norway", "terms": [ { "value": "hiking", "label": "Hiking", "sortOrder": 0 }, { "value": "kayaking", "label": "Kayaking", "sortOrder": 1 } ] }}Get the content model
GET/schemaKey required
The space's content types and components, with their fields. The SDK's type generator uses it. Deprecated components and hidden fields are left out.
Responses
200OKThe content model.dataSchemaFields of data
contentTypesobject[]Fields of contentTypes
keystringnamestringdescriptionstring or nullisGlobalbooleanfieldsSchemaField[]
componentsobject[]Fields of components
keystringnamestringdescriptionstring or nullgroupstring or nullallowedChildrenstring[] or "*"fieldsSchemaField[]
401UnauthorisedNo key, an unknown, deleted or expired key, a public key asking for drafts, a secret key from a browser, or a region or language the key may not read.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
402Payment requiredThe organisation's plan has ended, so delivery is paused.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
429Too many requestsToo many requests this minute. Retry-After says how many seconds to wait.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
500Server errorSomething went wrong on our side. Try again in a moment.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
curl 'https://api.bifrostorbit.com/cms/v1/schema' \ -H 'Authorization: Bearer cms_pk_…'Try it
Paste a public key above first.
Example answer
{ "data": { "contentTypes": [ { "key": "trip", "name": "Trip", "description": "A trip with its departures.", "isGlobal": false, "fields": [ { "key": "title", "name": "Title", "type": "text", "required": true, "description": null, "options": null, "allowedComponents": null, "allowedContentTypes": null, "taxonomy": null, "validation": null, "showWhen": null }, { "key": "days", "name": "Days", "type": "number", "required": true, "description": null, "options": null, "allowedComponents": null, "allowedContentTypes": null, "taxonomy": null, "validation": null, "showWhen": null } ] } ], "components": [ { "key": "hero", "name": "Hero", "description": null, "group": "Page top", "allowedChildren": [], "fields": [ { "key": "heading", "name": "Heading", "type": "text", "required": true, "description": null, "options": null, "allowedComponents": null, "allowedContentTypes": null, "taxonomy": null, "validation": null, "showWhen": null } ] } ] }}CampaignsBanners and popups live now.
List live banners
GET/bannersKey required
Banners live now for a page, pinned first and then by priority. serverTime lets countdowns tick from the CMS clock.
Parameters
pathstringqueryThe page being shown.
everyPagestringquerytrue returns the banners live on any page, each with the paths it targets, so a website can read them once. path is then ignored.
Only true.loggedInstringquerytrue when the visitor is signed in.
Only true.regionstringqueryRegion key or short code, such as germany or de. The space's first region unless you say.
localestringqueryLanguage code, such as de-DE. The region's default language unless you say.
draftstringquerytrue reads drafts instead of published content. Needs a secret key, from a server.
Only true.
Responses
200OKThe banners.dataobjectFields of data
serverTimestringitemsBanner[]
401UnauthorisedNo key, an unknown, deleted or expired key, a public key asking for drafts, a secret key from a browser, or a region or language the key may not read.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
402Payment requiredThe organisation's plan has ended, so delivery is paused.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
404Not foundNo region or language with that key, or the space has no region yet. The message says which, such as Region not found.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
429Too many requestsToo many requests this minute. Retry-After says how many seconds to wait.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
500Server errorSomething went wrong on our side. Try again in a moment.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
curl 'https://api.bifrostorbit.com/cms/v1/banners' \ -H 'Authorization: Bearer cms_pk_…'Try it
Paste a public key above first.
Example answer
{ "data": { "serverTime": "2026-11-02T09:30:00.000Z", "items": [ { "id": "6650f1c2a9e4b1d2c3f40a51", "blocks": [ { "id": "message-1", "type": "message" } ], "text": "Winter trips are open: book Lofoten by 30 November and save 10%", "segments": [ { "text": "Winter trips are open: ", "highlight": false }, { "text": "book Lofoten by 30 November and save 10%", "highlight": true } ], "link": { "kind": "url", "href": "/trips/lofoten-sea-kayaking", "target": null, "label": "See the trip" }, "background": "#1f2937", "foreground": "white", "placement": "aboveHeader", "paths": [ "/trips/*" ], "addresses": [ "/trips/*" ], "pinned": false, "priority": 10, "trackingLabel": "winter-lofoten", "countdown": null, "endsAt": "2026-11-30T22:59:59.000Z", "next": null } ] }}List live popups
GET/popupsKey required
Popups live now for a page and the visitor's sign-in state, highest priority first.
Parameters
pathstringqueryThe page being shown.
loggedInstringquerytrue when the visitor is signed in.
Only true.regionstringqueryRegion key or short code, such as germany or de. The space's first region unless you say.
localestringqueryLanguage code, such as de-DE. The region's default language unless you say.
draftstringquerytrue reads drafts instead of published content. Needs a secret key, from a server.
Only true.
Responses
200OKThe popups.dataobjectFields of data
serverTimestringitemsPopup[]
401UnauthorisedNo key, an unknown, deleted or expired key, a public key asking for drafts, a secret key from a browser, or a region or language the key may not read.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
402Payment requiredThe organisation's plan has ended, so delivery is paused.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
404Not foundNo region or language with that key, or the space has no region yet. The message says which, such as Region not found.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
429Too many requestsToo many requests this minute. Retry-After says how many seconds to wait.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
500Server errorSomething went wrong on our side. Try again in a moment.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
curl 'https://api.bifrostorbit.com/cms/v1/popups' \ -H 'Authorization: Bearer cms_pk_…'Try it
Paste a public key above first.
Example answer
{ "data": { "serverTime": "2026-11-02T09:30:00.000Z", "items": [ { "id": "6650f1c2a9e4b1d2c3f40a52", "name": "Trip newsletter", "layout": "corner", "style": "light", "minimisedText": "New trips", "blocks": [ { "id": "message-1", "type": "message" } ], "priority": 5, "hideForDays": 30, "maxViews": 3, "trackingLabel": "newsletter-autumn", "startsAt": null, "endsAt": null } ] }}Feature flagsThe environment's flags.
Get feature flags
GET/flagsKey required
The feature flags of the key's environment, each true or false. A flag that isn't in the answer doesn't exist; treat it as off.
Responses
200OKThe flags.dataobjectFields of data
flagsmap of boolean
401UnauthorisedNo key, an unknown, deleted or expired key, a public key asking for drafts, a secret key from a browser, or a region or language the key may not read.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
402Payment requiredThe organisation's plan has ended, so delivery is paused.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
429Too many requestsToo many requests this minute. Retry-After says how many seconds to wait.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
500Server errorSomething went wrong on our side. Try again in a moment.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
curl 'https://api.bifrostorbit.com/cms/v1/flags' \ -H 'Authorization: Bearer cms_pk_…'Try it
Paste a public key above first.
Example answer
{ "data": { "flags": { "new-booking-form": false, "header-search": true } }}ShopShop products with live prices and stock.
List shop products
GET/productsKey required
Shop products with live prices and stock, in their set order.
Parameters
pageintegerquery1 or more.
Default 1. At least 1.perPageintegerquery1 to 100, 24 unless you say. Larger values are capped at 100.
Default 24. At least 1. At most 100.filterstringqueryA taxonomy term value. Products tagged with it in any taxonomy field match.
regionstringqueryRegion key or short code, such as germany or de. The space's first region unless you say.
localestringqueryLanguage code, such as de-DE. The region's default language unless you say.
draftstringquerytrue reads drafts instead of published content. Needs a secret key, from a server.
Only true.
Responses
200OKA page of products. Ask for the next page while hasMore is true.dataProductsFields of data
itemsProduct[]totalintegerpageintegerhasMoreboolean
401UnauthorisedNo key, an unknown, deleted or expired key, a public key asking for drafts, a secret key from a browser, or a region or language the key may not read.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
402Payment requiredThe organisation's plan has ended, so delivery is paused.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
404Not foundNo region or language with that key, or the space has no region yet. The message says which, such as Region not found.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
429Too many requestsToo many requests this minute. Retry-After says how many seconds to wait.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
500Server errorSomething went wrong on our side. Try again in a moment.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
curl 'https://api.bifrostorbit.com/cms/v1/products' \ -H 'Authorization: Bearer cms_pk_…'Try it
Paste a public key above first.
Example answer
{ "data": { "items": [ { "slug": "fjell-gtx-boot", "url": "/gear/fjell-gtx-boot", "name": "Fjell GTX boot", "catalogId": "NW-FJELL-GTX-42", "size": "EU 42", "price": 2490, "currency": "NOK", "wasPrice": 2890, "inStock": true, "onSale": true, "badges": [ "Waterproof" ], "benefits": [ "Waterproof membrane", "Grippy sole for wet rock" ], "directions": null, "ingredients": null, "terms": null, "images": [ { "url": "https://media.northwilds.com/fjell-gtx-boot.webp", "width": 1600, "height": 1600, "alt": "A brown leather hiking boot" } ], "filters": [ { "taxonomy": "activity", "value": "hiking", "label": "Hiking" } ], "relatedSlugs": [ "merino-hiking-socks" ], "seo": { "title": "Fjell GTX boot" }, "publishedAt": "2026-11-02T09:30:00.000Z" } ], "total": 1, "page": 1, "hasMore": false }}Travel OrbitTrips, destinations and guides when the space is connected to Travel Orbit.
List trips, destinations or guides
GET/travel/{key}Key required
Every trip, destination or guide from Travel Orbit, for trip finders, destination grids and team pages. A space that isn't connected gets empty lists. trips are priced in the currency of the region asked for, when they are sold in it.
Parameters
keystringpath, requiredtrips, destinations or guides.
One of trips, destinations, guides.localestringqueryLanguage, such as de or nb-NO. en unless you say.
regionstringqueryRegion key or short code, such as germany or de. The space's first region unless you say.
draftstringquerytrue reads with draft templates, for the website addresses in pageUrl. Needs a secret key.
Only true.
Responses
200OKThe list.datamap of any[]Trips as in Trip fields without details; continents with their countries; or guides with slug, name, role, bio, photo, languages, tripCount and pageUrl.
401UnauthorisedNo key, an unknown, deleted or expired key, a public key asking for drafts, a secret key from a browser, or a region or language the key may not read.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
402Payment requiredThe organisation's plan has ended, so delivery is paused.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
404Not foundAnything other than trips, destinations or guides.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
429Too many requestsToo many requests this minute. Retry-After says how many seconds to wait.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
500Server errorSomething went wrong on our side. Try again in a moment.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
curl 'https://api.bifrostorbit.com/cms/v1/travel/trips' \ -H 'Authorization: Bearer cms_pk_…'Try it
Paste a public key above first.
Example answer
{ "data": [ { "slug": "kari-nordmann", "name": "Kari Nordmann", "role": "Sea kayak guide", "bio": "Kari has paddled the Lofoten coast for twelve summers.", "photo": null, "languages": [ "Norwegian", "English" ], "tripCount": 3, "pageUrl": "/guides/kari-nordmann" } ]}Search enginesSitemaps and robots.txt.
Get the sitemap
GET/sitemapKey required
Without region, the index of every region and language. With region, that region's entries. Only published pages with an address are listed, without pages set to no-index or left out of the sitemap.
Parameters
regionstringqueryRegion key or code. Leave out for the index.
localestringqueryLanguage code, such as de-DE. The region's default language unless you say.
pageintegerquerySitemap file number. Each holds up to 50,000 addresses.
Default 1. At least 1.
Responses
200OKThe index, or one region's sitemap.dataSitemapIndex or SitemapFields of data
One of:
SitemapIndex
indexablebooleansitemapsobject[]Fields of sitemaps
regionstringlocalestringbasestring or nullpagesintegerfilesintegerSitemap files, up to 50,000 addresses each.
Sitemap
regionstringlocalestringpageintegertotalPagesintegerentriesobject[]Fields of entries
locstringlastmodstring or nullchangefreqstring or nullprioritynumber or nullimagesobject[]Fields of images
locstringtitlestring or null
alternatesobject[]Fields of alternates
hreflangstringhrefstring
401UnauthorisedNo key, an unknown, deleted or expired key, a public key asking for drafts, a secret key from a browser, or a region or language the key may not read.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
402Payment requiredThe organisation's plan has ended, so delivery is paused.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
404Not foundNo region or language with that key, or the space has no region yet. The message says which, such as Region not found.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
429Too many requestsToo many requests this minute. Retry-After says how many seconds to wait.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
500Server errorSomething went wrong on our side. Try again in a moment.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
curl 'https://api.bifrostorbit.com/cms/v1/sitemap' \ -H 'Authorization: Bearer cms_pk_…'Try it
Paste a public key above first.
Example answer
{ "data": { "indexable": true, "sitemaps": [ { "region": "norway", "locale": "en-GB", "base": "https://northwilds.com", "pages": 182, "files": 1 }, { "region": "norway", "locale": "nb-NO", "base": "https://northwilds.com/no", "pages": 176, "files": 1 } ] }}Get robots.txt
GET/robotsKey required
The robots.txt for the environment. An environment that isn't indexable, such as staging, always gets User-agent: * and Disallow: /.
Responses
200OKThe robots.txt.dataobjectFields of data
indexablebooleancontentstringindexNowKeystring or nullThe key the website serves at /<key>.txt so search engines accept CMS Orbit's IndexNow pings. Null when IndexNow is switched off or the environment isn't indexable.
401UnauthorisedNo key, an unknown, deleted or expired key, a public key asking for drafts, a secret key from a browser, or a region or language the key may not read.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
402Payment requiredThe organisation's plan has ended, so delivery is paused.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
429Too many requestsToo many requests this minute. Retry-After says how many seconds to wait.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
500Server errorSomething went wrong on our side. Try again in a moment.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
curl 'https://api.bifrostorbit.com/cms/v1/robots' \ -H 'Authorization: Bearer cms_pk_…'Try it
Paste a public key above first.
Example answer
{ "data": { "indexable": true, "content": "User-agent: *\nAllow: /\nSitemap: https://northwilds.com/de/sitemap.xml\n", "indexNowKey": "4d3ea0be0ee6893746b17db2b51ca5f4" }}ExperimentsThe collector for experiment events.
Count experiment events
POST/experiments/collectNo key
Exposures and conversions from visitors' browsers, up to 20 events and 16 KB. It needs no key and allows any origin. Only running experiments count. Requests without a user agent, from bots or with Do Not Track or Global Privacy Control get 204 and count nothing. The SDK calls it for you.
Request body
Up to 20 items.eobject[]requiredFields of e
xstringrequiredThe experiment's key.
vstringrequiredThe visitor's key for this experiment.
tstringrequiredexposure when the visitor sees their variant, conversion when they reach goals.
One of exposure, conversion.astringoptionalFor an exposure: the variant's key, a to d.
gstring[]optionalFor a conversion: the goal keys reached.
Up to 5 items.
Responses
200OKCounted.dataobjectFields of data
acceptedinteger
204No contentNot counted: a bot, Do Not Track or Global Privacy Control.400Bad requestA body that can't be read.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
413Too largeOver 16 KB.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
429Too many requestsToo many events from one address this minute.errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
curl -X POST 'https://api.bifrostorbit.com/cms/v1/experiments/collect' \ -H 'Content-Type: application/json' \ -d '{"e":[{"x":"k7m2qx9wpa","v":"1gpjbpa07yg5e0","t":"exposure","a":"b"}]}'Try it
It counts towards real experiments.
Example answer
{ "data": { "accepted": 1 }}SchemasThe shapes the endpoints above answer with and take.
Error
errorobjectFields of error
One of bad_request, unauthorized, subscription_inactive, not_found, too_large, rate_limited, internal_error.codestringmessagestringSuch as Region not found.
Image
An image or file field, as delivered.
idstringurlstringChange the size and format with the image address helpers in the SDK.
mimeTypestringwidthinteger or nullheightinteger or nullaltstringtitlestring or nullsubtitlesstring or nullA video's subtitles file.
focalPointobject or nullFields of focalPoint
xnumber0 to 1 from the left.
ynumber0 to 1 from the top.
Seo
Ready-made metadata for the page.
titlestringdescriptionstringcanonicalstringrobotsobjectFields of robots
indexbooleanfollowboolean
openGraphobjectFields of openGraph
One of website, article.typestringtitlestringdescriptionstringurlstringsiteNamestringlocalestringSuch as de_DE.
imageobject or nullFields of image
urlstringwidthinteger or nullheightinteger or nullaltstring
twitterobjectFields of twitter
Only summary_large_image.cardstringsitestring or nulltitlestringdescriptionstringimageobject or nullFields of image
urlstringwidthinteger or nullheightinteger or nullaltstring
verificationobjectFields of verification
googlestring or nullbingstring or null
alternatesobject[]hreflang alternates.
Fields of alternates
hreflangstringhrefstring
breadcrumbsobject[]Fields of breadcrumbs
namestringurlstring
jsonLdmap of any[]Structured data to put in script tags.
Component
One component in a page body. Blocks in a slot arrive both in children and on the slot's field.
idstringtypestringThe component's key, such as hero.
schemaVersionintegerfieldsmap of anyThe component's fields.
childrenmap of Component[]Blocks by slot.
Fields of children
idstringtypestringThe component's key, such as hero.
schemaVersionintegerfieldsmap of anyThe component's fields.
childrenmap of Component[]Blocks by slot.
Fields of children
idstringtypestringThe component's key, such as hero.
schemaVersionintegerfieldsmap of anyThe component's fields.
childrenmap of Component[]Blocks by slot.
Fields of children
idstringtypestringThe component's key, such as hero.
schemaVersionintegerfieldsmap of anyThe component's fields.
childrenmap of Component[]Blocks by slot.
variantstring or null
variantstring or null
variantstring or null
variantstring or null
Page
A published page, or its draft.
idstringThe entry's id in this region and language, the same as in the management API.
urlstringSuch as /gear/fjell-gtx-boot.
namestringcontentTypestringlocalestringThe language that answered.
regionstringThe region that answered.
requestedLocalestringWhat was asked for, or the default.
requestedRegionstringWhat was asked for, or the default.
fallbackAppliedbooleanAnother language answered.
regionFallbackAppliedbooleanAnother region answered.
draftbooleanpublishedAtstring or nullWhen it was last published.
versionintegerThe published version, or the draft version for a draft.
fieldsmap of anyThe content type's fields. Images become Image objects and links carry the target page's current address. See https://docs.bifrostorbit.com/cms/developers/field-types/.
componentsComponent[]The page body.
seoSeoReady-made metadata for the page.
insightsobject or nullFields of insights
sitestringThe Insights Orbit site key, public like the script tag.
expiredobjectsometimesOnly on a campaign page past its end date that is set to stay visible.
Fields of expired
messagestringSuch as This offer has ended.
travelanysometimesOn a Travel Orbit page: kind (trip, destination or guide), slug and the item under that name. See https://docs.bifrostorbit.com/cms/developers/travel-pages/.
experimentsanysometimesOn a page with a running experiment: collect, assignment, tests and goals. See https://docs.bifrostorbit.com/cms/developers/experiments/.
Resolved
What an address is. The HTTP status follows kind.
One of:
object
kind"page"pagePageA published page, or its draft.
object
kind"redirect"destinationstringWhere to send the visitor.
statusCodeintegerSuch as 301.
permanentbooleantrue for 301 and 308.
hopsintegerRedirects followed to reach the final address.
object
kind"gone"
object
kind"notFound"
Entry
idstringThe entry's id, the same value a Reference field holds.
urlstring or nullnull for an entry without its own address.
namestringcontentTypestringpublishedAtstring or nullseoany or any or nullsometimesThe entry's SEO settings as editors saved them, such as title and description. null without an address, and left out when nothing was saved.
fieldsmap of anysometimesWith include=fields or include=references.
SearchItem
idstringThe entry's id in the language that answered.
urlstring or nullnull for an entry without its own address.
slugstringnamestringcontentTypestringlocalestringThe language that answered, which may be a fallback.
scorenumberOrders the entries within one answer. Not comparable between answers or modes.
snippetstring or nullA short passage of the entry's text, around the words asked for when they appear.
fallbackAppliedbooleanAnother language answered, because the entry has no version in the language asked for.
SearchResult
itemsSearchItem[]totalintegerEntries found. Search looks only at the closest matches, so this is not a count of every entry that mentions the words.
hasMorebooleangravityobjectFields of gravity
modestringHow the answer was found.
One of hybrid, semantic, keyword.fallbackbooleantrue when Gravity is off or can't be reached, and the answer has keyword results instead.
reasonstringsometimesWhy it fell back.
One of off, unavailable, busy, not_indexed.
List
itemsEntry[]totalintegerMatching entries across all pages.
pageintegerhasMorebooleanAsk for the next page while true.
Global
keystringnamestringcontentTypestringlocalestringThe language that answered, which may be a fallback.
fieldsmap of anycomponentsComponent[]
MenuItem
labelstringhrefstring or nullA page's current address, so renaming a page never breaks the menu.
targetstring or nulliconstring or nullbadgestring or nulldescriptionstring or nullchildrenMenuItem[]
Menu
keystringnamestringitemsMenuItem[]Hidden items, and items linking to a page not published here, are left out.
Region
keystringSuch as germany.
namestringlocalesobject[]Fields of locales
codestringSuch as de-DE.
namestringisDefaultboolean
Taxonomy
keystringnamestringregionstring or nullThe region the labels and hidden terms follow, or null when the space has none.
termsobject[]Fields of terms
valuestringlabelstringsortOrderinteger
SchemaField
keystringnamestringtypestringrequiredbooleandescriptionstring or nulloptionsobject[] or nullFields of options
labelstringvaluestring
allowedComponentsstring[] or nullallowedContentTypesstring[] or nulltaxonomystring or nullvalidationmap of any or nullshowWhenany or any or nullShow the field only when another field has a value.
stepnumbersometimesA slider's step.
unitstringsometimesA slider's unit, such as km, to show after its value.
halfStarsbooleansometimesA star rating that allows half stars. Its number of stars is validation.max.
languagesstring[]sometimesThe languages a code block allows.
Schema
contentTypesobject[]Fields of contentTypes
keystringnamestringdescriptionstring or nullisGlobalbooleanfieldsSchemaField[]
componentsobject[]Fields of components
keystringnamestringdescriptionstring or nullgroupstring or nullallowedChildrenstring[] or "*"fieldsSchemaField[]
Countdown
labelstring or nullstartsAtstring or nullendsAtstring or nulltimeZonestringstylestringiconstring or nullbuttonany or any or null
One of upcoming, running, ended.statusstring
One of countdown, hidden, followUp, ended.displaystringfollowUpobject or nullFields of followUp
textstringlinkany or any or null
endedTextstring or null
Banner
idstringblocksobject[]The blocks, for guests or signed-in visitors as asked.
Fields of blocks
idstringtypestringSuch as message or countdown.
textstringAll the text, for a simple banner.
segmentsobject[]The text in parts, with the highlighted parts marked.
Fields of segments
textstringhighlightboolean
linkany or any or nullA link field: kind, href, target and label.
backgroundstringA colour, such as #1f2937.
foregroundstringThe text colour the editor chose, or white or dark, whichever reads best on background.
One of aboveHeader, belowHeader.placementstringpathsstring[]The pages it targets, with /* at the end for a whole section. Empty for every page.
addressesstring[]The full addresses of those pages, with the region's prefix.
pinnedbooleanpriorityintegertrackingLabelstring or nullcountdownCountdown or any or nullFields of countdown
One of:
Countdown
labelstring or nullstartsAtstring or nullendsAtstring or nulltimeZonestringstylestringiconstring or nullbuttonany or any or null
One of upcoming, running, ended.statusstring
One of countdown, hidden, followUp, ended.displaystringfollowUpobject or nullFields of followUp
textstringlinkany or any or null
endedTextstring or null
any or null
endsAtstring or nullnextobject or nullThe banner that takes over when this one ends.
Fields of next
idstringblocksobject[]The blocks, for guests or signed-in visitors as asked.
Fields of blocks
idstringtypestringSuch as message or countdown.
textstringAll the text, for a simple banner.
segmentsobject[]The text in parts, with the highlighted parts marked.
Fields of segments
textstringhighlightboolean
linkany or any or nullA link field: kind, href, target and label.
backgroundstringA colour, such as #1f2937.
foregroundstringThe text colour the editor chose, or white or dark, whichever reads best on background.
One of aboveHeader, belowHeader.placementstringpathsstring[]The pages it targets, with /* at the end for a whole section. Empty for every page.
addressesstring[]The full addresses of those pages, with the region's prefix.
pinnedbooleanpriorityintegertrackingLabelstring or nullcountdownCountdown or any or nullFields of countdown
One of:
Countdown
labelstring or nullstartsAtstring or nullendsAtstring or nulltimeZonestringstylestringiconstring or nullbuttonany or any or null
One of upcoming, running, ended.statusstring
One of countdown, hidden, followUp, ended.displaystringfollowUpobject or nullendedTextstring or null
any or null
endsAtstring or nullstartsAtstring
Popup
idstringnamestringlayoutstringstylestringminimisedTextstring or nullblocksobject[]The blocks, for guests or signed-in visitors as asked.
Fields of blocks
idstringtypestringSuch as message or countdown.
priorityintegerhideForDaysinteger30 unless the editor says.
maxViewsinteger or nulltrackingLabelstring or nullstartsAtstring or nullendsAtstring or null
Product
slugstringurlstring or nullnamestringcatalogIdstring or nullLinks the product to the shop catalogue, which supplies price and inStock.
sizestring or nullpricenumber or nullnull when the product isn't linked or the catalogue can't be reached.
currencystring or nullwasPricenumber or nullinStockboolean or nullonSalebooleanbadgesstring[]benefitsanydirectionsanyingredientsanytermsstring or nullimagesobject[]Fields of images
urlstringwidthinteger or nullheightinteger or nullaltstring
filtersobject[]Fields of filters
taxonomystring or nullvaluestringlabelstring
relatedSlugsstring[]seoanypublishedAtstring or null
Products
itemsProduct[]totalintegerpageintegerhasMoreboolean
SitemapIndex
indexablebooleansitemapsobject[]Fields of sitemaps
regionstringlocalestringbasestring or nullpagesintegerfilesintegerSitemap files, up to 50,000 addresses each.
Sitemap
regionstringlocalestringpageintegertotalPagesintegerentriesobject[]Fields of entries
locstringlastmodstring or nullchangefreqstring or nullprioritynumber or nullimagesobject[]Fields of images
locstringtitlestring or null
alternatesobject[]Fields of alternates
hreflangstringhrefstring