{
  "openapi": "3.1.0",
  "info": {
    "title": "CMS Orbit delivery API",
    "version": "1",
    "summary": "Read published content: pages, lists, menus, globals, campaigns, flags, sitemaps and the content model.",
    "description": "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.\n\nSend 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.\n\nLeave 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.\n\nLists are paged with page and perPage, and answer with total, page and hasMore.",
    "contact": {
      "name": "Bifröst Orbit",
      "url": "https://docs.bifrostorbit.com/",
      "email": "hello@bifrostorbit.com"
    },
    "termsOfService": "https://bifrostorbit.com/legal/terms/"
  },
  "servers": [
    {
      "url": "https://api.bifrostorbit.com/cms/v1",
      "description": "Production"
    },
    {
      "url": "https://api-stage.bifrostorbit.com/cms/v1",
      "description": "Staging"
    }
  ],
  "tags": [
    {
      "name": "Pages",
      "description": "Pages by their address, with fallback and redirects."
    },
    {
      "name": "Lists",
      "description": "Entries of one content type."
    },
    {
      "name": "Search",
      "description": "Search by meaning and related entries, with Gravity."
    },
    {
      "name": "Site-wide content",
      "description": "Globals, menus, regions, taxonomies and the content model."
    },
    {
      "name": "Campaigns",
      "description": "Banners and popups live now."
    },
    {
      "name": "Feature flags",
      "description": "The environment's flags."
    },
    {
      "name": "Shop",
      "description": "Shop products with live prices and stock."
    },
    {
      "name": "Travel Orbit",
      "description": "Trips, destinations and guides when the space is connected to Travel Orbit."
    },
    {
      "name": "Search engines",
      "description": "Sitemaps and robots.txt."
    },
    {
      "name": "Experiments",
      "description": "The collector for experiment events."
    }
  ],
  "externalDocs": {
    "url": "https://docs.bifrostorbit.com/cms/developers/delivery-api/",
    "description": "The delivery API guide"
  },
  "paths": {
    "/resolve": {
      "get": {
        "operationId": "resolve",
        "tags": [
          "Pages"
        ],
        "summary": "Resolve an address",
        "description": "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": [
          {
            "name": "url",
            "in": "query",
            "description": "The page address. A missing leading slash is added and a trailing slash removed.",
            "schema": {
              "type": "string",
              "default": "/"
            },
            "example": "/"
          },
          {
            "name": "region",
            "in": "query",
            "description": "Region key or short code, such as germany or de. The space's first region unless you say.",
            "schema": {
              "type": "string"
            },
            "example": "de"
          },
          {
            "name": "locale",
            "in": "query",
            "description": "Language code, such as de-DE. The region's default language unless you say.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "strict",
            "in": "query",
            "description": "true refuses every fallback: the page must exist in the language and region asked for.",
            "schema": {
              "type": "string",
              "enum": [
                "true"
              ]
            }
          },
          {
            "name": "draft",
            "in": "query",
            "description": "true reads drafts instead of published content. Needs a secret key, from a server.",
            "schema": {
              "type": "string",
              "enum": [
                "true"
              ]
            }
          },
          {
            "name": "include",
            "in": "query",
            "description": "Extra content, separated by commas: references.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A page or a redirect.",
            "headers": {
              "X-RateLimit-Limit": {
                "description": "Requests allowed a minute for the key, or for the visitor's IP address when that is closer to its limit.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "Requests left this minute.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Seconds until the minute starts again.",
                "schema": {
                  "type": "string"
                }
              },
              "X-Cms-Cache": {
                "description": "hit or miss on published reads with a key, saying whether CMS Orbit answered from its own cache. Not sent for drafts.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/Resolved"
                    }
                  },
                  "required": [
                    "data"
                  ]
                },
                "example": {
                  "data": {
                    "kind": "redirect",
                    "destination": "/gear/fjell-gtx-boot",
                    "statusCode": 301,
                    "permanent": true,
                    "hops": 1
                  }
                }
              }
            }
          },
          "400": {
            "description": "An include other than fields or references.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "bad_request",
                    "message": "include may only list fields, references"
                  }
                }
              }
            }
          },
          "401": {
            "description": "No 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.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "unauthorized",
                    "message": "A valid API key is required"
                  }
                }
              }
            }
          },
          "402": {
            "description": "The organisation's plan has ended, so delivery is paused.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "subscription_inactive",
                    "message": "This website is paused because its CMS Orbit plan has ended. Nothing is deleted, and it comes back as soon as an owner chooses a plan under Billing in Bifröst Orbit."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Nothing was ever published here.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/Resolved"
                    }
                  },
                  "required": [
                    "data"
                  ]
                },
                "example": {
                  "data": {
                    "kind": "notFound"
                  }
                }
              }
            }
          },
          "410": {
            "description": "Published once and removed, or a campaign page that has ended.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/Resolved"
                    }
                  },
                  "required": [
                    "data"
                  ]
                },
                "example": {
                  "data": {
                    "kind": "gone"
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests this minute. Retry-After says how many seconds to wait.",
            "headers": {
              "Retry-After": {
                "description": "Seconds until you may try again.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Limit": {
                "description": "Requests allowed a minute for the key, or for the visitor's IP address when that is closer to its limit.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "Requests left this minute.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Seconds until the minute starts again.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "rate_limited",
                    "message": "Too many requests; try again shortly"
                  }
                }
              }
            }
          },
          "500": {
            "description": "Something went wrong on our side. Try again in a moment.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "internal_error",
                    "message": "The request failed"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearer": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "apiKeyQuery": []
          }
        ],
        "x-try-it": {
          "run": true
        }
      }
    },
    "/content": {
      "get": {
        "operationId": "getContent",
        "tags": [
          "Pages"
        ],
        "summary": "Get a page",
        "description": "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": [
          {
            "name": "url",
            "in": "query",
            "description": "The page address. A missing leading slash is added and a trailing slash removed.",
            "schema": {
              "type": "string",
              "default": "/"
            },
            "example": "/"
          },
          {
            "name": "region",
            "in": "query",
            "description": "Region key or short code, such as germany or de. The space's first region unless you say.",
            "schema": {
              "type": "string"
            },
            "example": "de"
          },
          {
            "name": "locale",
            "in": "query",
            "description": "Language code, such as de-DE. The region's default language unless you say.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "strict",
            "in": "query",
            "description": "true refuses every fallback: the page must exist in the language and region asked for.",
            "schema": {
              "type": "string",
              "enum": [
                "true"
              ]
            }
          },
          {
            "name": "draft",
            "in": "query",
            "description": "true reads drafts instead of published content. Needs a secret key, from a server.",
            "schema": {
              "type": "string",
              "enum": [
                "true"
              ]
            }
          },
          {
            "name": "include",
            "in": "query",
            "description": "Extra content, separated by commas: references.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The page.",
            "headers": {
              "X-RateLimit-Limit": {
                "description": "Requests allowed a minute for the key, or for the visitor's IP address when that is closer to its limit.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "Requests left this minute.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Seconds until the minute starts again.",
                "schema": {
                  "type": "string"
                }
              },
              "X-Cms-Cache": {
                "description": "hit or miss on published reads with a key, saying whether CMS Orbit answered from its own cache. Not sent for drafts.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/Page"
                    }
                  },
                  "required": [
                    "data"
                  ]
                },
                "example": {
                  "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
                  }
                }
              }
            }
          },
          "400": {
            "description": "An include other than fields or references.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "bad_request",
                    "message": "include may only list fields, references"
                  }
                }
              }
            }
          },
          "401": {
            "description": "No 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.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "unauthorized",
                    "message": "A valid API key is required"
                  }
                }
              }
            }
          },
          "402": {
            "description": "The organisation's plan has ended, so delivery is paused.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "subscription_inactive",
                    "message": "This website is paused because its CMS Orbit plan has ended. Nothing is deleted, and it comes back as soon as an owner chooses a plan under Billing in Bifröst Orbit."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Nothing at the address.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "not_found",
                    "message": "Content not found"
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests this minute. Retry-After says how many seconds to wait.",
            "headers": {
              "Retry-After": {
                "description": "Seconds until you may try again.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Limit": {
                "description": "Requests allowed a minute for the key, or for the visitor's IP address when that is closer to its limit.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "Requests left this minute.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Seconds until the minute starts again.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "rate_limited",
                    "message": "Too many requests; try again shortly"
                  }
                }
              }
            }
          },
          "500": {
            "description": "Something went wrong on our side. Try again in a moment.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "internal_error",
                    "message": "The request failed"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearer": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "apiKeyQuery": []
          }
        ],
        "x-try-it": {
          "run": true
        }
      }
    },
    "/list": {
      "get": {
        "operationId": "listEntries",
        "tags": [
          "Lists"
        ],
        "summary": "List entries",
        "description": "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": [
          {
            "name": "type",
            "in": "query",
            "description": "Content type key, such as product. Required in practice: without it the list is empty.",
            "schema": {
              "type": "string"
            },
            "example": "trip"
          },
          {
            "name": "page",
            "in": "query",
            "description": "1 or more.",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "default": 1
            }
          },
          {
            "name": "perPage",
            "in": "query",
            "description": "1 to 100, 20 unless you say. Larger values are capped at 100.",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "default": 20
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "sortOrder (the editors' order, the default), name, -name, publishedAt, -publishedAt, updatedAt or -updatedAt.",
            "schema": {
              "type": "string",
              "enum": [
                "sortOrder",
                "name",
                "-name",
                "publishedAt",
                "-publishedAt",
                "updatedAt",
                "-updatedAt"
              ]
            }
          },
          {
            "name": "tag",
            "in": "query",
            "description": "Entries whose tags field contains this.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "category",
            "in": "query",
            "description": "Entries whose category field equals this.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "q",
            "in": "query",
            "description": "Entries whose name contains this text, ignoring case.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "region",
            "in": "query",
            "description": "Region key or short code, such as germany or de. The space's first region unless you say.",
            "schema": {
              "type": "string"
            },
            "example": "de"
          },
          {
            "name": "locale",
            "in": "query",
            "description": "Language code, such as de-DE. The region's default language unless you say.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "draft",
            "in": "query",
            "description": "true reads drafts instead of published content. Needs a secret key, from a server.",
            "schema": {
              "type": "string",
              "enum": [
                "true"
              ]
            }
          },
          {
            "name": "include",
            "in": "query",
            "description": "Extra content, separated by commas: fields, references (which implies fields).",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A page of entries. Ask for the next page while hasMore is true.",
            "headers": {
              "X-RateLimit-Limit": {
                "description": "Requests allowed a minute for the key, or for the visitor's IP address when that is closer to its limit.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "Requests left this minute.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Seconds until the minute starts again.",
                "schema": {
                  "type": "string"
                }
              },
              "X-Cms-Cache": {
                "description": "hit or miss on published reads with a key, saying whether CMS Orbit answered from its own cache. Not sent for drafts.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/List"
                    }
                  },
                  "required": [
                    "data"
                  ]
                },
                "example": {
                  "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
                  }
                }
              }
            }
          },
          "400": {
            "description": "An unknown sort, a filter name that isn't a valid field key, or an unknown include.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "bad_request",
                    "message": "include may only list fields, references"
                  }
                }
              }
            }
          },
          "401": {
            "description": "No 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.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "unauthorized",
                    "message": "A valid API key is required"
                  }
                }
              }
            }
          },
          "402": {
            "description": "The organisation's plan has ended, so delivery is paused.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "subscription_inactive",
                    "message": "This website is paused because its CMS Orbit plan has ended. Nothing is deleted, and it comes back as soon as an owner chooses a plan under Billing in Bifröst Orbit."
                  }
                }
              }
            }
          },
          "404": {
            "description": "No region or language with that key, or the space has no region yet. The message says which, such as Region not found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "not_found",
                    "message": "Region not found"
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests this minute. Retry-After says how many seconds to wait.",
            "headers": {
              "Retry-After": {
                "description": "Seconds until you may try again.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Limit": {
                "description": "Requests allowed a minute for the key, or for the visitor's IP address when that is closer to its limit.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "Requests left this minute.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Seconds until the minute starts again.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "rate_limited",
                    "message": "Too many requests; try again shortly"
                  }
                }
              }
            }
          },
          "500": {
            "description": "Something went wrong on our side. Try again in a moment.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "internal_error",
                    "message": "The request failed"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearer": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "apiKeyQuery": []
          }
        ],
        "x-try-it": {
          "run": true
        }
      }
    },
    "/search": {
      "get": {
        "operationId": "search",
        "tags": [
          "Search"
        ],
        "summary": "Search by meaning",
        "description": "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": [
          {
            "name": "q",
            "in": "query",
            "required": true,
            "description": "What to look for, 2 to 200 characters.",
            "schema": {
              "type": "string"
            },
            "example": "warm clothes for winter"
          },
          {
            "name": "mode",
            "in": "query",
            "description": "hybrid (the default), semantic or keyword.",
            "schema": {
              "type": "string",
              "enum": [
                "hybrid",
                "semantic",
                "keyword"
              ]
            }
          },
          {
            "name": "type",
            "in": "query",
            "description": "Content type keys, separated by commas, such as gear,journalPost.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "tag",
            "in": "query",
            "description": "Entries whose tags field contains one of these, separated by commas.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "path",
            "in": "query",
            "description": "Only entries at this address or below it, such as /gear.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "1 to 50, 10 unless you say.",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 50,
              "default": 10
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "Entries to skip, 0 to 200.",
            "schema": {
              "type": "integer",
              "minimum": 0,
              "maximum": 200,
              "default": 0
            }
          },
          {
            "name": "region",
            "in": "query",
            "description": "Region key or short code, such as germany or de. The space's first region unless you say.",
            "schema": {
              "type": "string"
            },
            "example": "de"
          },
          {
            "name": "locale",
            "in": "query",
            "description": "Language code, such as de-DE, or several separated by commas. The region's default language unless you say.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "strict",
            "in": "query",
            "description": "true refuses every fallback: the page must exist in the language and region asked for.",
            "schema": {
              "type": "string",
              "enum": [
                "true"
              ]
            }
          },
          {
            "name": "draft",
            "in": "query",
            "description": "true reads drafts instead of published content. Needs a secret key, from a server.",
            "schema": {
              "type": "string",
              "enum": [
                "true"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The entries, best first.",
            "headers": {
              "X-RateLimit-Limit": {
                "description": "Requests allowed a minute for the key, or for the visitor's IP address when that is closer to its limit.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "Requests left this minute.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Seconds until the minute starts again.",
                "schema": {
                  "type": "string"
                }
              },
              "X-Cms-Cache": {
                "description": "hit or miss on published reads with a key, saying whether CMS Orbit answered from its own cache. Not sent for drafts.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/SearchResult"
                    }
                  },
                  "required": [
                    "data"
                  ]
                },
                "example": {
                  "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
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "No q, a q over 200 characters or an unknown mode.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "bad_request",
                    "message": "q needs at least two characters"
                  }
                }
              }
            }
          },
          "401": {
            "description": "No 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.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "unauthorized",
                    "message": "A valid API key is required"
                  }
                }
              }
            }
          },
          "402": {
            "description": "The organisation's plan has ended, so delivery is paused.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "subscription_inactive",
                    "message": "This website is paused because its CMS Orbit plan has ended. Nothing is deleted, and it comes back as soon as an owner chooses a plan under Billing in Bifröst Orbit."
                  }
                }
              }
            }
          },
          "404": {
            "description": "No region or language with that key, or the space has no region yet. The message says which, such as Region not found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "not_found",
                    "message": "Region not found"
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests this minute. Retry-After says how many seconds to wait.",
            "headers": {
              "Retry-After": {
                "description": "Seconds until you may try again.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Limit": {
                "description": "Requests allowed a minute for the key, or for the visitor's IP address when that is closer to its limit.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "Requests left this minute.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Seconds until the minute starts again.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "rate_limited",
                    "message": "Too many requests; try again shortly"
                  }
                }
              }
            }
          },
          "500": {
            "description": "Something went wrong on our side. Try again in a moment.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "internal_error",
                    "message": "The request failed"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearer": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "apiKeyQuery": []
          }
        ],
        "x-try-it": {
          "run": true
        }
      }
    },
    "/related": {
      "get": {
        "operationId": "related",
        "tags": [
          "Search"
        ],
        "summary": "Related entries",
        "description": "Entries closest in meaning to one entry, for lists such as You may also like, with Gravity. The entry's own translations are left out. It answers in the language asked for, or the entry's own. When Gravity is off, can't be reached or hasn't indexed the entry yet, the answer has entries with similar names and gravity.fallback is true.",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "required": true,
            "description": "The entry's id, as in the page or list answers.",
            "schema": {
              "type": "string"
            },
            "example": "6650f1c2a9e4b1d2c3f40a32"
          },
          {
            "name": "type",
            "in": "query",
            "description": "Content type keys, separated by commas.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "tag",
            "in": "query",
            "description": "Tags, separated by commas.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "path",
            "in": "query",
            "description": "Only entries at this address or below it.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "1 to 20, 5 unless you say.",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 20,
              "default": 5
            }
          },
          {
            "name": "region",
            "in": "query",
            "description": "Region key or short code, such as germany or de. The space's first region unless you say.",
            "schema": {
              "type": "string"
            },
            "example": "de"
          },
          {
            "name": "locale",
            "in": "query",
            "description": "Language code, such as de-DE. The region's default language unless you say.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "strict",
            "in": "query",
            "description": "true refuses every fallback: the page must exist in the language and region asked for.",
            "schema": {
              "type": "string",
              "enum": [
                "true"
              ]
            }
          },
          {
            "name": "draft",
            "in": "query",
            "description": "true reads drafts instead of published content. Needs a secret key, from a server.",
            "schema": {
              "type": "string",
              "enum": [
                "true"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The related entries, closest first.",
            "headers": {
              "X-RateLimit-Limit": {
                "description": "Requests allowed a minute for the key, or for the visitor's IP address when that is closer to its limit.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "Requests left this minute.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Seconds until the minute starts again.",
                "schema": {
                  "type": "string"
                }
              },
              "X-Cms-Cache": {
                "description": "hit or miss on published reads with a key, saying whether CMS Orbit answered from its own cache. Not sent for drafts.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/SearchResult"
                    }
                  },
                  "required": [
                    "data"
                  ]
                },
                "example": {
                  "data": {
                    "items": [
                      {
                        "id": "6650f1c2a9e4b1d2c3f40a33",
                        "url": "/gear/storm-shell-jacket",
                        "slug": "storm-shell-jacket",
                        "name": "Storm shell jacket",
                        "contentType": "gear",
                        "locale": "en",
                        "score": 0.871,
                        "snippet": "A three-layer waterproof, breathable shell jacket…",
                        "fallbackApplied": false
                      }
                    ],
                    "total": 1,
                    "hasMore": false,
                    "gravity": {
                      "mode": "semantic",
                      "fallback": false
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "No id, or an id that isn't one.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "bad_request",
                    "message": "id must be an entry id"
                  }
                }
              }
            }
          },
          "401": {
            "description": "No 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.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "unauthorized",
                    "message": "A valid API key is required"
                  }
                }
              }
            }
          },
          "402": {
            "description": "The organisation's plan has ended, so delivery is paused.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "subscription_inactive",
                    "message": "This website is paused because its CMS Orbit plan has ended. Nothing is deleted, and it comes back as soon as an owner chooses a plan under Billing in Bifröst Orbit."
                  }
                }
              }
            }
          },
          "404": {
            "description": "No visible entry with that id for this key.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "not_found",
                    "message": "Content not found"
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests this minute. Retry-After says how many seconds to wait.",
            "headers": {
              "Retry-After": {
                "description": "Seconds until you may try again.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Limit": {
                "description": "Requests allowed a minute for the key, or for the visitor's IP address when that is closer to its limit.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "Requests left this minute.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Seconds until the minute starts again.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "rate_limited",
                    "message": "Too many requests; try again shortly"
                  }
                }
              }
            }
          },
          "500": {
            "description": "Something went wrong on our side. Try again in a moment.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "internal_error",
                    "message": "The request failed"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearer": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "apiKeyQuery": []
          }
        ],
        "x-try-it": {
          "run": true
        }
      }
    },
    "/global": {
      "get": {
        "operationId": "getGlobal",
        "tags": [
          "Site-wide content"
        ],
        "summary": "Get a global entry",
        "description": "A global entry, such as the footer, by its key. It follows the language fallback, but not the region fallback.",
        "parameters": [
          {
            "name": "key",
            "in": "query",
            "required": true,
            "description": "The global entry's key.",
            "schema": {
              "type": "string"
            },
            "example": "footer"
          },
          {
            "name": "region",
            "in": "query",
            "description": "Region key or short code, such as germany or de. The space's first region unless you say.",
            "schema": {
              "type": "string"
            },
            "example": "de"
          },
          {
            "name": "locale",
            "in": "query",
            "description": "Language code, such as de-DE. The region's default language unless you say.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "strict",
            "in": "query",
            "description": "true refuses every fallback: the page must exist in the language and region asked for.",
            "schema": {
              "type": "string",
              "enum": [
                "true"
              ]
            }
          },
          {
            "name": "draft",
            "in": "query",
            "description": "true reads drafts instead of published content. Needs a secret key, from a server.",
            "schema": {
              "type": "string",
              "enum": [
                "true"
              ]
            }
          },
          {
            "name": "include",
            "in": "query",
            "description": "Extra content, separated by commas: references.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The entry.",
            "headers": {
              "X-RateLimit-Limit": {
                "description": "Requests allowed a minute for the key, or for the visitor's IP address when that is closer to its limit.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "Requests left this minute.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Seconds until the minute starts again.",
                "schema": {
                  "type": "string"
                }
              },
              "X-Cms-Cache": {
                "description": "hit or miss on published reads with a key, saying whether CMS Orbit answered from its own cache. Not sent for drafts.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/Global"
                    }
                  },
                  "required": [
                    "data"
                  ]
                },
                "example": {
                  "data": {
                    "key": "footer",
                    "name": "Footer",
                    "contentType": "footer",
                    "locale": "de-DE",
                    "fields": {
                      "copyright": "© Northwilds"
                    },
                    "components": []
                  }
                }
              }
            }
          },
          "400": {
            "description": "An include other than fields or references.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "bad_request",
                    "message": "include may only list fields, references"
                  }
                }
              }
            }
          },
          "401": {
            "description": "No 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.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "unauthorized",
                    "message": "A valid API key is required"
                  }
                }
              }
            }
          },
          "402": {
            "description": "The organisation's plan has ended, so delivery is paused.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "subscription_inactive",
                    "message": "This website is paused because its CMS Orbit plan has ended. Nothing is deleted, and it comes back as soon as an owner chooses a plan under Billing in Bifröst Orbit."
                  }
                }
              }
            }
          },
          "404": {
            "description": "No global entry with that key.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "not_found",
                    "message": "Global content not found"
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests this minute. Retry-After says how many seconds to wait.",
            "headers": {
              "Retry-After": {
                "description": "Seconds until you may try again.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Limit": {
                "description": "Requests allowed a minute for the key, or for the visitor's IP address when that is closer to its limit.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "Requests left this minute.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Seconds until the minute starts again.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "rate_limited",
                    "message": "Too many requests; try again shortly"
                  }
                }
              }
            }
          },
          "500": {
            "description": "Something went wrong on our side. Try again in a moment.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "internal_error",
                    "message": "The request failed"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearer": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "apiKeyQuery": []
          }
        ],
        "x-try-it": {
          "run": true
        }
      }
    },
    "/navigation": {
      "get": {
        "operationId": "getNavigation",
        "tags": [
          "Site-wide content"
        ],
        "summary": "Get a menu",
        "description": "A menu, by its key. A menu can be shared by all regions or belong to one.",
        "parameters": [
          {
            "name": "key",
            "in": "query",
            "required": true,
            "description": "The menu key.",
            "schema": {
              "type": "string"
            },
            "example": "main"
          },
          {
            "name": "region",
            "in": "query",
            "description": "Region key or short code, such as germany or de. The space's first region unless you say.",
            "schema": {
              "type": "string"
            },
            "example": "de"
          },
          {
            "name": "locale",
            "in": "query",
            "description": "Language code, such as de-DE. The region's default language unless you say.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "draft",
            "in": "query",
            "description": "true reads drafts instead of published content. Needs a secret key, from a server.",
            "schema": {
              "type": "string",
              "enum": [
                "true"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The menu.",
            "headers": {
              "X-RateLimit-Limit": {
                "description": "Requests allowed a minute for the key, or for the visitor's IP address when that is closer to its limit.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "Requests left this minute.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Seconds until the minute starts again.",
                "schema": {
                  "type": "string"
                }
              },
              "X-Cms-Cache": {
                "description": "hit or miss on published reads with a key, saying whether CMS Orbit answered from its own cache. Not sent for drafts.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/Menu"
                    }
                  },
                  "required": [
                    "data"
                  ]
                },
                "example": {
                  "data": {
                    "key": "main",
                    "name": "Main menu",
                    "items": [
                      {
                        "label": "Trips",
                        "href": "/trips",
                        "target": null,
                        "icon": null,
                        "badge": null,
                        "description": null,
                        "children": [
                          {
                            "label": "Lofoten sea kayaking",
                            "href": "/trips/lofoten-sea-kayaking",
                            "target": null,
                            "icon": null,
                            "badge": "New",
                            "description": null,
                            "children": []
                          }
                        ]
                      },
                      {
                        "label": "Gear",
                        "href": "/gear",
                        "target": null,
                        "icon": null,
                        "badge": null,
                        "description": null,
                        "children": []
                      },
                      {
                        "label": "Our Oslo shop",
                        "href": "/shop/oslo",
                        "target": null,
                        "icon": null,
                        "badge": null,
                        "description": "Try boots on in Grünerløkka",
                        "children": []
                      }
                    ]
                  }
                }
              }
            }
          },
          "401": {
            "description": "No 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.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "unauthorized",
                    "message": "A valid API key is required"
                  }
                }
              }
            }
          },
          "402": {
            "description": "The organisation's plan has ended, so delivery is paused.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "subscription_inactive",
                    "message": "This website is paused because its CMS Orbit plan has ended. Nothing is deleted, and it comes back as soon as an owner chooses a plan under Billing in Bifröst Orbit."
                  }
                }
              }
            }
          },
          "404": {
            "description": "No menu with that key.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "not_found",
                    "message": "Navigation not found"
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests this minute. Retry-After says how many seconds to wait.",
            "headers": {
              "Retry-After": {
                "description": "Seconds until you may try again.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Limit": {
                "description": "Requests allowed a minute for the key, or for the visitor's IP address when that is closer to its limit.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "Requests left this minute.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Seconds until the minute starts again.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "rate_limited",
                    "message": "Too many requests; try again shortly"
                  }
                }
              }
            }
          },
          "500": {
            "description": "Something went wrong on our side. Try again in a moment.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "internal_error",
                    "message": "The request failed"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearer": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "apiKeyQuery": []
          }
        ],
        "x-try-it": {
          "run": true
        }
      }
    },
    "/regions": {
      "get": {
        "operationId": "listRegions",
        "tags": [
          "Site-wide content"
        ],
        "summary": "List regions",
        "description": "The regions the key may read, with their languages.",
        "responses": {
          "200": {
            "description": "The regions.",
            "headers": {
              "X-RateLimit-Limit": {
                "description": "Requests allowed a minute for the key, or for the visitor's IP address when that is closer to its limit.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "Requests left this minute.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Seconds until the minute starts again.",
                "schema": {
                  "type": "string"
                }
              },
              "X-Cms-Cache": {
                "description": "hit or miss on published reads with a key, saying whether CMS Orbit answered from its own cache. Not sent for drafts.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Region"
                      }
                    }
                  },
                  "required": [
                    "data"
                  ]
                },
                "example": {
                  "data": [
                    {
                      "key": "germany",
                      "name": "Germany",
                      "locales": [
                        {
                          "code": "de-DE",
                          "name": "German (Germany)",
                          "isDefault": true
                        },
                        {
                          "code": "en-DE",
                          "name": "English",
                          "isDefault": false
                        }
                      ]
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "description": "No 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.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "unauthorized",
                    "message": "A valid API key is required"
                  }
                }
              }
            }
          },
          "402": {
            "description": "The organisation's plan has ended, so delivery is paused.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "subscription_inactive",
                    "message": "This website is paused because its CMS Orbit plan has ended. Nothing is deleted, and it comes back as soon as an owner chooses a plan under Billing in Bifröst Orbit."
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests this minute. Retry-After says how many seconds to wait.",
            "headers": {
              "Retry-After": {
                "description": "Seconds until you may try again.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Limit": {
                "description": "Requests allowed a minute for the key, or for the visitor's IP address when that is closer to its limit.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "Requests left this minute.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Seconds until the minute starts again.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "rate_limited",
                    "message": "Too many requests; try again shortly"
                  }
                }
              }
            }
          },
          "500": {
            "description": "Something went wrong on our side. Try again in a moment.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "internal_error",
                    "message": "The request failed"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearer": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "apiKeyQuery": []
          }
        ],
        "x-try-it": {
          "run": true
        }
      }
    },
    "/taxonomies/{key}": {
      "get": {
        "operationId": "getTaxonomy",
        "tags": [
          "Site-wide content"
        ],
        "summary": "Get a taxonomy",
        "description": "A taxonomy and its terms, in their set order.",
        "parameters": [
          {
            "name": "key",
            "in": "path",
            "required": true,
            "description": "The taxonomy's key.",
            "schema": {
              "type": "string"
            },
            "example": "activity"
          },
          {
            "name": "region",
            "in": "query",
            "description": "Region 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.",
            "schema": {
              "type": "string"
            },
            "example": "de"
          },
          {
            "name": "locale",
            "in": "query",
            "description": "Language for the term labels. A term without a label in it uses the language's fallback, then its default label.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The taxonomy.",
            "headers": {
              "X-RateLimit-Limit": {
                "description": "Requests allowed a minute for the key, or for the visitor's IP address when that is closer to its limit.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "Requests left this minute.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Seconds until the minute starts again.",
                "schema": {
                  "type": "string"
                }
              },
              "X-Cms-Cache": {
                "description": "hit or miss on published reads with a key, saying whether CMS Orbit answered from its own cache. Not sent for drafts.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/Taxonomy"
                    }
                  },
                  "required": [
                    "data"
                  ]
                },
                "example": {
                  "data": {
                    "key": "activity",
                    "name": "Activity",
                    "region": "norway",
                    "terms": [
                      {
                        "value": "hiking",
                        "label": "Hiking",
                        "sortOrder": 0
                      },
                      {
                        "value": "kayaking",
                        "label": "Kayaking",
                        "sortOrder": 1
                      }
                    ]
                  }
                }
              }
            }
          },
          "401": {
            "description": "No 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.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "unauthorized",
                    "message": "A valid API key is required"
                  }
                }
              }
            }
          },
          "402": {
            "description": "The organisation's plan has ended, so delivery is paused.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "subscription_inactive",
                    "message": "This website is paused because its CMS Orbit plan has ended. Nothing is deleted, and it comes back as soon as an owner chooses a plan under Billing in Bifröst Orbit."
                  }
                }
              }
            }
          },
          "404": {
            "description": "No taxonomy, or no region, with that key.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "not_found",
                    "message": "Taxonomy not found"
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests this minute. Retry-After says how many seconds to wait.",
            "headers": {
              "Retry-After": {
                "description": "Seconds until you may try again.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Limit": {
                "description": "Requests allowed a minute for the key, or for the visitor's IP address when that is closer to its limit.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "Requests left this minute.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Seconds until the minute starts again.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "rate_limited",
                    "message": "Too many requests; try again shortly"
                  }
                }
              }
            }
          },
          "500": {
            "description": "Something went wrong on our side. Try again in a moment.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "internal_error",
                    "message": "The request failed"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearer": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "apiKeyQuery": []
          }
        ],
        "x-try-it": {
          "run": true
        }
      }
    },
    "/schema": {
      "get": {
        "operationId": "getSchema",
        "tags": [
          "Site-wide content"
        ],
        "summary": "Get the content model",
        "description": "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": {
          "200": {
            "description": "The content model.",
            "headers": {
              "X-RateLimit-Limit": {
                "description": "Requests allowed a minute for the key, or for the visitor's IP address when that is closer to its limit.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "Requests left this minute.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Seconds until the minute starts again.",
                "schema": {
                  "type": "string"
                }
              },
              "X-Cms-Cache": {
                "description": "hit or miss on published reads with a key, saying whether CMS Orbit answered from its own cache. Not sent for drafts.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/Schema"
                    }
                  },
                  "required": [
                    "data"
                  ]
                },
                "example": {
                  "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
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          },
          "401": {
            "description": "No 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.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "unauthorized",
                    "message": "A valid API key is required"
                  }
                }
              }
            }
          },
          "402": {
            "description": "The organisation's plan has ended, so delivery is paused.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "subscription_inactive",
                    "message": "This website is paused because its CMS Orbit plan has ended. Nothing is deleted, and it comes back as soon as an owner chooses a plan under Billing in Bifröst Orbit."
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests this minute. Retry-After says how many seconds to wait.",
            "headers": {
              "Retry-After": {
                "description": "Seconds until you may try again.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Limit": {
                "description": "Requests allowed a minute for the key, or for the visitor's IP address when that is closer to its limit.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "Requests left this minute.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Seconds until the minute starts again.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "rate_limited",
                    "message": "Too many requests; try again shortly"
                  }
                }
              }
            }
          },
          "500": {
            "description": "Something went wrong on our side. Try again in a moment.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "internal_error",
                    "message": "The request failed"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearer": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "apiKeyQuery": []
          }
        ],
        "x-try-it": {
          "run": true
        }
      }
    },
    "/banners": {
      "get": {
        "operationId": "listBanners",
        "tags": [
          "Campaigns"
        ],
        "summary": "List live banners",
        "description": "Banners live now for a page, pinned first and then by priority. serverTime lets countdowns tick from the CMS clock.",
        "parameters": [
          {
            "name": "path",
            "in": "query",
            "description": "The page being shown.",
            "schema": {
              "type": "string"
            },
            "example": "/"
          },
          {
            "name": "everyPage",
            "in": "query",
            "description": "true returns the banners live on any page, each with the paths it targets, so a website can read them once. path is then ignored.",
            "schema": {
              "type": "string",
              "enum": [
                "true"
              ]
            }
          },
          {
            "name": "loggedIn",
            "in": "query",
            "description": "true when the visitor is signed in.",
            "schema": {
              "type": "string",
              "enum": [
                "true"
              ]
            }
          },
          {
            "name": "region",
            "in": "query",
            "description": "Region key or short code, such as germany or de. The space's first region unless you say.",
            "schema": {
              "type": "string"
            },
            "example": "de"
          },
          {
            "name": "locale",
            "in": "query",
            "description": "Language code, such as de-DE. The region's default language unless you say.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "draft",
            "in": "query",
            "description": "true reads drafts instead of published content. Needs a secret key, from a server.",
            "schema": {
              "type": "string",
              "enum": [
                "true"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The banners.",
            "headers": {
              "X-RateLimit-Limit": {
                "description": "Requests allowed a minute for the key, or for the visitor's IP address when that is closer to its limit.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "Requests left this minute.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Seconds until the minute starts again.",
                "schema": {
                  "type": "string"
                }
              },
              "X-Cms-Cache": {
                "description": "hit or miss on published reads with a key, saying whether CMS Orbit answered from its own cache. Not sent for drafts.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "serverTime": {
                          "type": "string",
                          "format": "date-time"
                        },
                        "items": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Banner"
                          }
                        }
                      },
                      "required": [
                        "serverTime",
                        "items"
                      ]
                    }
                  },
                  "required": [
                    "data"
                  ]
                },
                "example": {
                  "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
                      }
                    ]
                  }
                }
              }
            }
          },
          "401": {
            "description": "No 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.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "unauthorized",
                    "message": "A valid API key is required"
                  }
                }
              }
            }
          },
          "402": {
            "description": "The organisation's plan has ended, so delivery is paused.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "subscription_inactive",
                    "message": "This website is paused because its CMS Orbit plan has ended. Nothing is deleted, and it comes back as soon as an owner chooses a plan under Billing in Bifröst Orbit."
                  }
                }
              }
            }
          },
          "404": {
            "description": "No region or language with that key, or the space has no region yet. The message says which, such as Region not found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "not_found",
                    "message": "Region not found"
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests this minute. Retry-After says how many seconds to wait.",
            "headers": {
              "Retry-After": {
                "description": "Seconds until you may try again.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Limit": {
                "description": "Requests allowed a minute for the key, or for the visitor's IP address when that is closer to its limit.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "Requests left this minute.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Seconds until the minute starts again.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "rate_limited",
                    "message": "Too many requests; try again shortly"
                  }
                }
              }
            }
          },
          "500": {
            "description": "Something went wrong on our side. Try again in a moment.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "internal_error",
                    "message": "The request failed"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearer": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "apiKeyQuery": []
          }
        ],
        "x-try-it": {
          "run": true
        }
      }
    },
    "/popups": {
      "get": {
        "operationId": "listPopups",
        "tags": [
          "Campaigns"
        ],
        "summary": "List live popups",
        "description": "Popups live now for a page and the visitor's sign-in state, highest priority first.",
        "parameters": [
          {
            "name": "path",
            "in": "query",
            "description": "The page being shown.",
            "schema": {
              "type": "string"
            },
            "example": "/"
          },
          {
            "name": "loggedIn",
            "in": "query",
            "description": "true when the visitor is signed in.",
            "schema": {
              "type": "string",
              "enum": [
                "true"
              ]
            }
          },
          {
            "name": "region",
            "in": "query",
            "description": "Region key or short code, such as germany or de. The space's first region unless you say.",
            "schema": {
              "type": "string"
            },
            "example": "de"
          },
          {
            "name": "locale",
            "in": "query",
            "description": "Language code, such as de-DE. The region's default language unless you say.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "draft",
            "in": "query",
            "description": "true reads drafts instead of published content. Needs a secret key, from a server.",
            "schema": {
              "type": "string",
              "enum": [
                "true"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The popups.",
            "headers": {
              "X-RateLimit-Limit": {
                "description": "Requests allowed a minute for the key, or for the visitor's IP address when that is closer to its limit.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "Requests left this minute.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Seconds until the minute starts again.",
                "schema": {
                  "type": "string"
                }
              },
              "X-Cms-Cache": {
                "description": "hit or miss on published reads with a key, saying whether CMS Orbit answered from its own cache. Not sent for drafts.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "serverTime": {
                          "type": "string",
                          "format": "date-time"
                        },
                        "items": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Popup"
                          }
                        }
                      },
                      "required": [
                        "serverTime",
                        "items"
                      ]
                    }
                  },
                  "required": [
                    "data"
                  ]
                },
                "example": {
                  "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
                      }
                    ]
                  }
                }
              }
            }
          },
          "401": {
            "description": "No 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.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "unauthorized",
                    "message": "A valid API key is required"
                  }
                }
              }
            }
          },
          "402": {
            "description": "The organisation's plan has ended, so delivery is paused.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "subscription_inactive",
                    "message": "This website is paused because its CMS Orbit plan has ended. Nothing is deleted, and it comes back as soon as an owner chooses a plan under Billing in Bifröst Orbit."
                  }
                }
              }
            }
          },
          "404": {
            "description": "No region or language with that key, or the space has no region yet. The message says which, such as Region not found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "not_found",
                    "message": "Region not found"
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests this minute. Retry-After says how many seconds to wait.",
            "headers": {
              "Retry-After": {
                "description": "Seconds until you may try again.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Limit": {
                "description": "Requests allowed a minute for the key, or for the visitor's IP address when that is closer to its limit.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "Requests left this minute.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Seconds until the minute starts again.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "rate_limited",
                    "message": "Too many requests; try again shortly"
                  }
                }
              }
            }
          },
          "500": {
            "description": "Something went wrong on our side. Try again in a moment.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "internal_error",
                    "message": "The request failed"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearer": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "apiKeyQuery": []
          }
        ],
        "x-try-it": {
          "run": true
        }
      }
    },
    "/flags": {
      "get": {
        "operationId": "getFlags",
        "tags": [
          "Feature flags"
        ],
        "summary": "Get feature flags",
        "description": "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": {
          "200": {
            "description": "The flags.",
            "headers": {
              "X-RateLimit-Limit": {
                "description": "Requests allowed a minute for the key, or for the visitor's IP address when that is closer to its limit.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "Requests left this minute.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Seconds until the minute starts again.",
                "schema": {
                  "type": "string"
                }
              },
              "X-Cms-Cache": {
                "description": "hit or miss on published reads with a key, saying whether CMS Orbit answered from its own cache. Not sent for drafts.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "flags": {
                          "type": "object",
                          "additionalProperties": {
                            "type": "boolean"
                          }
                        }
                      },
                      "required": [
                        "flags"
                      ]
                    }
                  },
                  "required": [
                    "data"
                  ]
                },
                "example": {
                  "data": {
                    "flags": {
                      "new-booking-form": false,
                      "header-search": true
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "No 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.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "unauthorized",
                    "message": "A valid API key is required"
                  }
                }
              }
            }
          },
          "402": {
            "description": "The organisation's plan has ended, so delivery is paused.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "subscription_inactive",
                    "message": "This website is paused because its CMS Orbit plan has ended. Nothing is deleted, and it comes back as soon as an owner chooses a plan under Billing in Bifröst Orbit."
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests this minute. Retry-After says how many seconds to wait.",
            "headers": {
              "Retry-After": {
                "description": "Seconds until you may try again.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Limit": {
                "description": "Requests allowed a minute for the key, or for the visitor's IP address when that is closer to its limit.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "Requests left this minute.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Seconds until the minute starts again.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "rate_limited",
                    "message": "Too many requests; try again shortly"
                  }
                }
              }
            }
          },
          "500": {
            "description": "Something went wrong on our side. Try again in a moment.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "internal_error",
                    "message": "The request failed"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearer": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "apiKeyQuery": []
          }
        ],
        "x-try-it": {
          "run": true
        }
      }
    },
    "/products": {
      "get": {
        "operationId": "listProducts",
        "tags": [
          "Shop"
        ],
        "summary": "List shop products",
        "description": "Shop products with live prices and stock, in their set order.",
        "parameters": [
          {
            "name": "page",
            "in": "query",
            "description": "1 or more.",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "default": 1
            }
          },
          {
            "name": "perPage",
            "in": "query",
            "description": "1 to 100, 24 unless you say. Larger values are capped at 100.",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "default": 24
            }
          },
          {
            "name": "filter",
            "in": "query",
            "description": "A taxonomy term value. Products tagged with it in any taxonomy field match.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "region",
            "in": "query",
            "description": "Region key or short code, such as germany or de. The space's first region unless you say.",
            "schema": {
              "type": "string"
            },
            "example": "de"
          },
          {
            "name": "locale",
            "in": "query",
            "description": "Language code, such as de-DE. The region's default language unless you say.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "draft",
            "in": "query",
            "description": "true reads drafts instead of published content. Needs a secret key, from a server.",
            "schema": {
              "type": "string",
              "enum": [
                "true"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A page of products. Ask for the next page while hasMore is true.",
            "headers": {
              "X-RateLimit-Limit": {
                "description": "Requests allowed a minute for the key, or for the visitor's IP address when that is closer to its limit.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "Requests left this minute.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Seconds until the minute starts again.",
                "schema": {
                  "type": "string"
                }
              },
              "X-Cms-Cache": {
                "description": "hit or miss on published reads with a key, saying whether CMS Orbit answered from its own cache. Not sent for drafts.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/Products"
                    }
                  },
                  "required": [
                    "data"
                  ]
                },
                "example": {
                  "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
                  }
                }
              }
            }
          },
          "401": {
            "description": "No 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.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "unauthorized",
                    "message": "A valid API key is required"
                  }
                }
              }
            }
          },
          "402": {
            "description": "The organisation's plan has ended, so delivery is paused.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "subscription_inactive",
                    "message": "This website is paused because its CMS Orbit plan has ended. Nothing is deleted, and it comes back as soon as an owner chooses a plan under Billing in Bifröst Orbit."
                  }
                }
              }
            }
          },
          "404": {
            "description": "No region or language with that key, or the space has no region yet. The message says which, such as Region not found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "not_found",
                    "message": "Region not found"
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests this minute. Retry-After says how many seconds to wait.",
            "headers": {
              "Retry-After": {
                "description": "Seconds until you may try again.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Limit": {
                "description": "Requests allowed a minute for the key, or for the visitor's IP address when that is closer to its limit.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "Requests left this minute.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Seconds until the minute starts again.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "rate_limited",
                    "message": "Too many requests; try again shortly"
                  }
                }
              }
            }
          },
          "500": {
            "description": "Something went wrong on our side. Try again in a moment.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "internal_error",
                    "message": "The request failed"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearer": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "apiKeyQuery": []
          }
        ],
        "x-try-it": {
          "run": true
        }
      }
    },
    "/travel/{key}": {
      "get": {
        "operationId": "listTravel",
        "tags": [
          "Travel Orbit"
        ],
        "summary": "List trips, destinations or guides",
        "description": "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": [
          {
            "name": "key",
            "in": "path",
            "required": true,
            "description": "trips, destinations or guides.",
            "schema": {
              "type": "string",
              "enum": [
                "trips",
                "destinations",
                "guides"
              ]
            },
            "example": "trips"
          },
          {
            "name": "locale",
            "in": "query",
            "description": "Language, such as de or nb-NO. en unless you say.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "region",
            "in": "query",
            "description": "Region key or short code, such as germany or de. The space's first region unless you say.",
            "schema": {
              "type": "string"
            },
            "example": "de"
          },
          {
            "name": "draft",
            "in": "query",
            "description": "true reads with draft templates, for the website addresses in pageUrl. Needs a secret key.",
            "schema": {
              "type": "string",
              "enum": [
                "true"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The list.",
            "headers": {
              "X-RateLimit-Limit": {
                "description": "Requests allowed a minute for the key, or for the visitor's IP address when that is closer to its limit.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "Requests left this minute.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Seconds until the minute starts again.",
                "schema": {
                  "type": "string"
                }
              },
              "X-Cms-Cache": {
                "description": "hit or miss on published reads with a key, saying whether CMS Orbit answered from its own cache. Not sent for drafts.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "additionalProperties": {}
                      },
                      "description": "Trips as in Trip fields without details; continents with their countries; or guides with slug, name, role, bio, photo, languages, tripCount and pageUrl."
                    }
                  },
                  "required": [
                    "data"
                  ]
                },
                "example": {
                  "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"
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "description": "No 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.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "unauthorized",
                    "message": "A valid API key is required"
                  }
                }
              }
            }
          },
          "402": {
            "description": "The organisation's plan has ended, so delivery is paused.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "subscription_inactive",
                    "message": "This website is paused because its CMS Orbit plan has ended. Nothing is deleted, and it comes back as soon as an owner chooses a plan under Billing in Bifröst Orbit."
                  }
                }
              }
            }
          },
          "404": {
            "description": "Anything other than trips, destinations or guides.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "not_found",
                    "message": "List not found"
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests this minute. Retry-After says how many seconds to wait.",
            "headers": {
              "Retry-After": {
                "description": "Seconds until you may try again.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Limit": {
                "description": "Requests allowed a minute for the key, or for the visitor's IP address when that is closer to its limit.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "Requests left this minute.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Seconds until the minute starts again.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "rate_limited",
                    "message": "Too many requests; try again shortly"
                  }
                }
              }
            }
          },
          "500": {
            "description": "Something went wrong on our side. Try again in a moment.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "internal_error",
                    "message": "The request failed"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearer": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "apiKeyQuery": []
          }
        ],
        "x-try-it": {
          "run": true
        }
      }
    },
    "/sitemap": {
      "get": {
        "operationId": "getSitemap",
        "tags": [
          "Search engines"
        ],
        "summary": "Get the sitemap",
        "description": "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": [
          {
            "name": "region",
            "in": "query",
            "description": "Region key or code. Leave out for the index.",
            "schema": {
              "type": "string"
            },
            "example": "de"
          },
          {
            "name": "locale",
            "in": "query",
            "description": "Language code, such as de-DE. The region's default language unless you say.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Sitemap file number. Each holds up to 50,000 addresses.",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "default": 1
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The index, or one region's sitemap.",
            "headers": {
              "X-RateLimit-Limit": {
                "description": "Requests allowed a minute for the key, or for the visitor's IP address when that is closer to its limit.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "Requests left this minute.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Seconds until the minute starts again.",
                "schema": {
                  "type": "string"
                }
              },
              "X-Cms-Cache": {
                "description": "hit or miss on published reads with a key, saying whether CMS Orbit answered from its own cache. Not sent for drafts.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "oneOf": [
                        {
                          "$ref": "#/components/schemas/SitemapIndex"
                        },
                        {
                          "$ref": "#/components/schemas/Sitemap"
                        }
                      ]
                    }
                  },
                  "required": [
                    "data"
                  ]
                },
                "example": {
                  "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
                      }
                    ]
                  }
                }
              }
            }
          },
          "401": {
            "description": "No 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.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "unauthorized",
                    "message": "A valid API key is required"
                  }
                }
              }
            }
          },
          "402": {
            "description": "The organisation's plan has ended, so delivery is paused.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "subscription_inactive",
                    "message": "This website is paused because its CMS Orbit plan has ended. Nothing is deleted, and it comes back as soon as an owner chooses a plan under Billing in Bifröst Orbit."
                  }
                }
              }
            }
          },
          "404": {
            "description": "No region or language with that key, or the space has no region yet. The message says which, such as Region not found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "not_found",
                    "message": "Region not found"
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests this minute. Retry-After says how many seconds to wait.",
            "headers": {
              "Retry-After": {
                "description": "Seconds until you may try again.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Limit": {
                "description": "Requests allowed a minute for the key, or for the visitor's IP address when that is closer to its limit.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "Requests left this minute.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Seconds until the minute starts again.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "rate_limited",
                    "message": "Too many requests; try again shortly"
                  }
                }
              }
            }
          },
          "500": {
            "description": "Something went wrong on our side. Try again in a moment.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "internal_error",
                    "message": "The request failed"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearer": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "apiKeyQuery": []
          }
        ],
        "x-try-it": {
          "run": true
        }
      }
    },
    "/robots": {
      "get": {
        "operationId": "getRobots",
        "tags": [
          "Search engines"
        ],
        "summary": "Get robots.txt",
        "description": "The robots.txt for the environment. An environment that isn't indexable, such as staging, always gets User-agent: * and Disallow: /.",
        "responses": {
          "200": {
            "description": "The robots.txt.",
            "headers": {
              "X-RateLimit-Limit": {
                "description": "Requests allowed a minute for the key, or for the visitor's IP address when that is closer to its limit.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "Requests left this minute.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Seconds until the minute starts again.",
                "schema": {
                  "type": "string"
                }
              },
              "X-Cms-Cache": {
                "description": "hit or miss on published reads with a key, saying whether CMS Orbit answered from its own cache. Not sent for drafts.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "indexable": {
                          "type": "boolean"
                        },
                        "content": {
                          "type": "string"
                        },
                        "indexNowKey": {
                          "type": [
                            "string",
                            "null"
                          ],
                          "description": "The 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."
                        }
                      },
                      "required": [
                        "indexable",
                        "content",
                        "indexNowKey"
                      ]
                    }
                  },
                  "required": [
                    "data"
                  ]
                },
                "example": {
                  "data": {
                    "indexable": true,
                    "content": "User-agent: *\nAllow: /\nSitemap: https://northwilds.com/de/sitemap.xml\n",
                    "indexNowKey": "4d3ea0be0ee6893746b17db2b51ca5f4"
                  }
                }
              }
            }
          },
          "401": {
            "description": "No 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.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "unauthorized",
                    "message": "A valid API key is required"
                  }
                }
              }
            }
          },
          "402": {
            "description": "The organisation's plan has ended, so delivery is paused.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "subscription_inactive",
                    "message": "This website is paused because its CMS Orbit plan has ended. Nothing is deleted, and it comes back as soon as an owner chooses a plan under Billing in Bifröst Orbit."
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests this minute. Retry-After says how many seconds to wait.",
            "headers": {
              "Retry-After": {
                "description": "Seconds until you may try again.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Limit": {
                "description": "Requests allowed a minute for the key, or for the visitor's IP address when that is closer to its limit.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "Requests left this minute.",
                "schema": {
                  "type": "string"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Seconds until the minute starts again.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "rate_limited",
                    "message": "Too many requests; try again shortly"
                  }
                }
              }
            }
          },
          "500": {
            "description": "Something went wrong on our side. Try again in a moment.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "internal_error",
                    "message": "The request failed"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearer": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "apiKeyQuery": []
          }
        ],
        "x-try-it": {
          "run": true
        }
      }
    },
    "/experiments/collect": {
      "post": {
        "operationId": "collectExperimentEvents",
        "tags": [
          "Experiments"
        ],
        "summary": "Count experiment events",
        "description": "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.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "e": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "x": {
                          "type": "string",
                          "description": "The experiment's key.",
                          "pattern": "^[a-z0-9]{6,16}$"
                        },
                        "v": {
                          "type": "string",
                          "description": "The visitor's key for this experiment.",
                          "pattern": "^[a-z0-9]{8,32}$"
                        },
                        "t": {
                          "type": "string",
                          "description": "exposure when the visitor sees their variant, conversion when they reach goals.",
                          "enum": [
                            "exposure",
                            "conversion"
                          ]
                        },
                        "a": {
                          "type": "string",
                          "description": "For an exposure: the variant's key, a to d.",
                          "pattern": "^[a-d]$"
                        },
                        "g": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "pattern": "^(goal|g[1-3]|engaged)$"
                          },
                          "description": "For a conversion: the goal keys reached.",
                          "maxItems": 5
                        }
                      },
                      "required": [
                        "x",
                        "v",
                        "t"
                      ]
                    },
                    "minItems": 1,
                    "maxItems": 20
                  }
                },
                "required": [
                  "e"
                ]
              },
              "example": {
                "e": [
                  {
                    "x": "k7m2qx9wpa",
                    "v": "1gpjbpa07yg5e0",
                    "t": "exposure",
                    "a": "b"
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Counted.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "accepted": {
                          "type": "integer"
                        }
                      },
                      "required": [
                        "accepted"
                      ]
                    }
                  },
                  "required": [
                    "data"
                  ]
                },
                "example": {
                  "data": {
                    "accepted": 1
                  }
                }
              }
            }
          },
          "204": {
            "description": "Not counted: a bot, Do Not Track or Global Privacy Control."
          },
          "400": {
            "description": "A body that can't be read.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "bad_request",
                    "message": "Those events could not be read"
                  }
                }
              }
            }
          },
          "413": {
            "description": "Over 16 KB.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "too_large",
                    "message": "Too many events at once"
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many events from one address this minute.",
            "headers": {
              "Retry-After": {
                "description": "Seconds until you may try again.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "rate_limited",
                    "message": "Too many events"
                  }
                }
              }
            }
          }
        },
        "security": [],
        "x-try-it": {
          "run": false,
          "reason": "It counts towards real experiments."
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Error": {
        "type": "object",
        "properties": {
          "error": {
            "type": "object",
            "properties": {
              "code": {
                "type": "string",
                "enum": [
                  "bad_request",
                  "unauthorized",
                  "subscription_inactive",
                  "not_found",
                  "too_large",
                  "rate_limited",
                  "internal_error"
                ]
              },
              "message": {
                "type": "string",
                "description": "Such as Region not found."
              }
            },
            "required": [
              "code",
              "message"
            ]
          }
        },
        "required": [
          "error"
        ]
      },
      "Image": {
        "type": "object",
        "description": "An image or file field, as delivered.",
        "properties": {
          "id": {
            "type": "string"
          },
          "url": {
            "type": "string",
            "description": "Change the size and format with the image address helpers in the SDK."
          },
          "mimeType": {
            "type": "string"
          },
          "width": {
            "type": [
              "integer",
              "null"
            ]
          },
          "height": {
            "type": [
              "integer",
              "null"
            ]
          },
          "alt": {
            "type": "string"
          },
          "title": {
            "type": [
              "string",
              "null"
            ]
          },
          "subtitles": {
            "type": [
              "string",
              "null"
            ],
            "description": "A video's subtitles file."
          },
          "focalPoint": {
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "x": {
                "type": "number",
                "description": "0 to 1 from the left."
              },
              "y": {
                "type": "number",
                "description": "0 to 1 from the top."
              }
            },
            "required": [
              "x",
              "y"
            ]
          }
        },
        "required": [
          "id",
          "url",
          "mimeType",
          "width",
          "height",
          "alt",
          "title",
          "subtitles",
          "focalPoint"
        ]
      },
      "Seo": {
        "type": "object",
        "description": "Ready-made metadata for the page.",
        "properties": {
          "title": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "canonical": {
            "type": "string"
          },
          "robots": {
            "type": "object",
            "properties": {
              "index": {
                "type": "boolean"
              },
              "follow": {
                "type": "boolean"
              }
            },
            "required": [
              "index",
              "follow"
            ]
          },
          "openGraph": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "website",
                  "article"
                ]
              },
              "title": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "url": {
                "type": "string"
              },
              "siteName": {
                "type": "string"
              },
              "locale": {
                "type": "string",
                "description": "Such as de_DE."
              },
              "image": {
                "type": [
                  "object",
                  "null"
                ],
                "properties": {
                  "url": {
                    "type": "string"
                  },
                  "width": {
                    "type": [
                      "integer",
                      "null"
                    ]
                  },
                  "height": {
                    "type": [
                      "integer",
                      "null"
                    ]
                  },
                  "alt": {
                    "type": "string"
                  }
                },
                "required": [
                  "url",
                  "width",
                  "height",
                  "alt"
                ]
              }
            },
            "required": [
              "type",
              "title",
              "description",
              "url",
              "siteName",
              "locale",
              "image"
            ]
          },
          "twitter": {
            "type": "object",
            "properties": {
              "card": {
                "type": "string",
                "enum": [
                  "summary_large_image"
                ]
              },
              "site": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "title": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "image": {
                "type": [
                  "object",
                  "null"
                ],
                "properties": {
                  "url": {
                    "type": "string"
                  },
                  "width": {
                    "type": [
                      "integer",
                      "null"
                    ]
                  },
                  "height": {
                    "type": [
                      "integer",
                      "null"
                    ]
                  },
                  "alt": {
                    "type": "string"
                  }
                },
                "required": [
                  "url",
                  "width",
                  "height",
                  "alt"
                ]
              }
            },
            "required": [
              "card",
              "site",
              "title",
              "description",
              "image"
            ]
          },
          "verification": {
            "type": "object",
            "properties": {
              "google": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "bing": {
                "type": [
                  "string",
                  "null"
                ]
              }
            },
            "required": [
              "google",
              "bing"
            ]
          },
          "alternates": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "hreflang": {
                  "type": "string"
                },
                "href": {
                  "type": "string"
                }
              },
              "required": [
                "hreflang",
                "href"
              ]
            },
            "description": "hreflang alternates."
          },
          "breadcrumbs": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "url": {
                  "type": "string"
                }
              },
              "required": [
                "name",
                "url"
              ]
            }
          },
          "jsonLd": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": {}
            },
            "description": "Structured data to put in script tags."
          }
        },
        "required": [
          "title",
          "description",
          "canonical",
          "robots",
          "openGraph",
          "twitter",
          "verification",
          "alternates",
          "breadcrumbs",
          "jsonLd"
        ]
      },
      "Component": {
        "type": "object",
        "description": "One component in a page body. Blocks in a slot arrive both in children and on the slot's field.",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "description": "The component's key, such as hero."
          },
          "schemaVersion": {
            "type": "integer"
          },
          "fields": {
            "type": "object",
            "additionalProperties": {},
            "description": "The component's fields."
          },
          "children": {
            "type": "object",
            "additionalProperties": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/Component"
              }
            },
            "description": "Blocks by slot."
          },
          "variant": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "id",
          "type",
          "schemaVersion",
          "fields",
          "children",
          "variant"
        ]
      },
      "Page": {
        "type": "object",
        "description": "A published page, or its draft.",
        "properties": {
          "id": {
            "type": "string",
            "description": "The entry's id in this region and language, the same as in the management API."
          },
          "url": {
            "type": "string",
            "description": "Such as /gear/fjell-gtx-boot."
          },
          "name": {
            "type": "string"
          },
          "contentType": {
            "type": "string"
          },
          "locale": {
            "type": "string",
            "description": "The language that answered."
          },
          "region": {
            "type": "string",
            "description": "The region that answered."
          },
          "requestedLocale": {
            "type": "string",
            "description": "What was asked for, or the default."
          },
          "requestedRegion": {
            "type": "string",
            "description": "What was asked for, or the default."
          },
          "fallbackApplied": {
            "type": "boolean",
            "description": "Another language answered."
          },
          "regionFallbackApplied": {
            "type": "boolean",
            "description": "Another region answered."
          },
          "draft": {
            "type": "boolean"
          },
          "publishedAt": {
            "type": [
              "string",
              "null"
            ],
            "description": "When it was last published.",
            "format": "date-time"
          },
          "version": {
            "type": "integer",
            "description": "The published version, or the draft version for a draft."
          },
          "fields": {
            "type": "object",
            "additionalProperties": {},
            "description": "The 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/."
          },
          "components": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Component"
            },
            "description": "The page body."
          },
          "seo": {
            "$ref": "#/components/schemas/Seo"
          },
          "insights": {
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "site": {
                "type": "string",
                "description": "The Insights Orbit site key, public like the script tag."
              }
            },
            "required": [
              "site"
            ]
          },
          "expired": {
            "type": "object",
            "description": "Only on a campaign page past its end date that is set to stay visible.",
            "properties": {
              "message": {
                "type": "string",
                "description": "Such as This offer has ended."
              }
            },
            "required": [
              "message"
            ]
          },
          "travel": {
            "description": "On 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/."
          },
          "experiments": {
            "description": "On a page with a running experiment: collect, assignment, tests and goals. See https://docs.bifrostorbit.com/cms/developers/experiments/."
          }
        },
        "required": [
          "id",
          "url",
          "name",
          "contentType",
          "locale",
          "region",
          "requestedLocale",
          "requestedRegion",
          "fallbackApplied",
          "regionFallbackApplied",
          "draft",
          "publishedAt",
          "version",
          "fields",
          "components",
          "seo",
          "insights"
        ]
      },
      "Resolved": {
        "description": "What an address is. The HTTP status follows kind.",
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "kind": {
                "const": "page"
              },
              "page": {
                "$ref": "#/components/schemas/Page"
              }
            },
            "required": [
              "kind",
              "page"
            ]
          },
          {
            "type": "object",
            "properties": {
              "kind": {
                "const": "redirect"
              },
              "destination": {
                "type": "string",
                "description": "Where to send the visitor."
              },
              "statusCode": {
                "type": "integer",
                "description": "Such as 301."
              },
              "permanent": {
                "type": "boolean",
                "description": "true for 301 and 308."
              },
              "hops": {
                "type": "integer",
                "description": "Redirects followed to reach the final address."
              }
            },
            "required": [
              "kind",
              "destination",
              "statusCode",
              "permanent",
              "hops"
            ]
          },
          {
            "type": "object",
            "properties": {
              "kind": {
                "const": "gone"
              }
            },
            "required": [
              "kind"
            ]
          },
          {
            "type": "object",
            "properties": {
              "kind": {
                "const": "notFound"
              }
            },
            "required": [
              "kind"
            ]
          }
        ]
      },
      "Entry": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The entry's id, the same value a Reference field holds."
          },
          "url": {
            "type": [
              "string",
              "null"
            ],
            "description": "null for an entry without its own address."
          },
          "name": {
            "type": "string"
          },
          "contentType": {
            "type": "string"
          },
          "publishedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "seo": {
            "description": "The entry's SEO settings as editors saved them, such as title and description. null without an address, and left out when nothing was saved.",
            "anyOf": [
              {},
              {
                "type": "null"
              }
            ]
          },
          "fields": {
            "type": "object",
            "additionalProperties": {},
            "description": "With include=fields or include=references."
          }
        },
        "required": [
          "id",
          "url",
          "name",
          "contentType",
          "publishedAt"
        ]
      },
      "SearchItem": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The entry's id in the language that answered."
          },
          "url": {
            "type": [
              "string",
              "null"
            ],
            "description": "null for an entry without its own address."
          },
          "slug": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "contentType": {
            "type": "string"
          },
          "locale": {
            "type": "string",
            "description": "The language that answered, which may be a fallback."
          },
          "score": {
            "type": "number",
            "description": "Orders the entries within one answer. Not comparable between answers or modes."
          },
          "snippet": {
            "type": [
              "string",
              "null"
            ],
            "description": "A short passage of the entry's text, around the words asked for when they appear."
          },
          "fallbackApplied": {
            "type": "boolean",
            "description": "Another language answered, because the entry has no version in the language asked for."
          }
        },
        "required": [
          "id",
          "url",
          "slug",
          "name",
          "contentType",
          "locale",
          "score",
          "snippet",
          "fallbackApplied"
        ]
      },
      "SearchResult": {
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SearchItem"
            }
          },
          "total": {
            "type": "integer",
            "description": "Entries found. Search looks only at the closest matches, so this is not a count of every entry that mentions the words."
          },
          "hasMore": {
            "type": "boolean"
          },
          "gravity": {
            "type": "object",
            "properties": {
              "mode": {
                "type": "string",
                "description": "How the answer was found.",
                "enum": [
                  "hybrid",
                  "semantic",
                  "keyword"
                ]
              },
              "fallback": {
                "type": "boolean",
                "description": "true when Gravity is off or can't be reached, and the answer has keyword results instead."
              },
              "reason": {
                "type": "string",
                "description": "Why it fell back.",
                "enum": [
                  "off",
                  "unavailable",
                  "busy",
                  "not_indexed"
                ]
              }
            },
            "required": [
              "mode",
              "fallback"
            ]
          }
        },
        "required": [
          "items",
          "total",
          "hasMore",
          "gravity"
        ]
      },
      "List": {
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Entry"
            }
          },
          "total": {
            "type": "integer",
            "description": "Matching entries across all pages."
          },
          "page": {
            "type": "integer"
          },
          "hasMore": {
            "type": "boolean",
            "description": "Ask for the next page while true."
          }
        },
        "required": [
          "items",
          "total",
          "page",
          "hasMore"
        ]
      },
      "Global": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "contentType": {
            "type": "string"
          },
          "locale": {
            "type": "string",
            "description": "The language that answered, which may be a fallback."
          },
          "fields": {
            "type": "object",
            "additionalProperties": {}
          },
          "components": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Component"
            }
          }
        },
        "required": [
          "key",
          "name",
          "contentType",
          "locale",
          "fields",
          "components"
        ]
      },
      "MenuItem": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string"
          },
          "href": {
            "type": [
              "string",
              "null"
            ],
            "description": "A page's current address, so renaming a page never breaks the menu."
          },
          "target": {
            "type": [
              "string",
              "null"
            ]
          },
          "icon": {
            "type": [
              "string",
              "null"
            ]
          },
          "badge": {
            "type": [
              "string",
              "null"
            ]
          },
          "description": {
            "type": [
              "string",
              "null"
            ]
          },
          "children": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/MenuItem"
            }
          }
        },
        "required": [
          "label",
          "href",
          "target",
          "icon",
          "badge",
          "description",
          "children"
        ]
      },
      "Menu": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/MenuItem"
            },
            "description": "Hidden items, and items linking to a page not published here, are left out."
          }
        },
        "required": [
          "key",
          "name",
          "items"
        ]
      },
      "Region": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "description": "Such as germany."
          },
          "name": {
            "type": "string"
          },
          "locales": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "code": {
                  "type": "string",
                  "description": "Such as de-DE."
                },
                "name": {
                  "type": "string"
                },
                "isDefault": {
                  "type": "boolean"
                }
              },
              "required": [
                "code",
                "name",
                "isDefault"
              ]
            }
          }
        },
        "required": [
          "key",
          "name",
          "locales"
        ]
      },
      "Taxonomy": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "region": {
            "type": [
              "string",
              "null"
            ],
            "description": "The region the labels and hidden terms follow, or null when the space has none."
          },
          "terms": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "value": {
                  "type": "string"
                },
                "label": {
                  "type": "string"
                },
                "sortOrder": {
                  "type": "integer"
                }
              },
              "required": [
                "value",
                "label",
                "sortOrder"
              ]
            }
          }
        },
        "required": [
          "key",
          "name",
          "region",
          "terms"
        ]
      },
      "SchemaField": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "required": {
            "type": "boolean"
          },
          "description": {
            "type": [
              "string",
              "null"
            ]
          },
          "options": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "object",
              "properties": {
                "label": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              },
              "required": [
                "label",
                "value"
              ]
            }
          },
          "allowedComponents": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string"
            }
          },
          "allowedContentTypes": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string"
            }
          },
          "taxonomy": {
            "type": [
              "string",
              "null"
            ]
          },
          "validation": {
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": {}
          },
          "showWhen": {
            "description": "Show the field only when another field has a value.",
            "anyOf": [
              {},
              {
                "type": "null"
              }
            ]
          },
          "step": {
            "type": "number",
            "description": "A slider's step."
          },
          "unit": {
            "type": "string",
            "description": "A slider's unit, such as km, to show after its value."
          },
          "halfStars": {
            "type": "boolean",
            "description": "A star rating that allows half stars. Its number of stars is validation.max."
          },
          "languages": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The languages a code block allows."
          }
        },
        "required": [
          "key",
          "name",
          "type",
          "required",
          "description",
          "options",
          "allowedComponents",
          "allowedContentTypes",
          "taxonomy",
          "validation",
          "showWhen"
        ]
      },
      "Schema": {
        "type": "object",
        "properties": {
          "contentTypes": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "description": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "isGlobal": {
                  "type": "boolean"
                },
                "fields": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/SchemaField"
                  }
                }
              },
              "required": [
                "key",
                "name",
                "description",
                "isGlobal",
                "fields"
              ]
            }
          },
          "components": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "description": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "group": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "allowedChildren": {
                  "anyOf": [
                    {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    {
                      "const": "*"
                    }
                  ]
                },
                "fields": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/SchemaField"
                  }
                }
              },
              "required": [
                "key",
                "name",
                "description",
                "group",
                "allowedChildren",
                "fields"
              ]
            }
          }
        },
        "required": [
          "contentTypes",
          "components"
        ]
      },
      "Countdown": {
        "type": "object",
        "properties": {
          "label": {
            "type": [
              "string",
              "null"
            ]
          },
          "startsAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "endsAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "timeZone": {
            "type": "string"
          },
          "style": {
            "type": "string"
          },
          "icon": {
            "type": [
              "string",
              "null"
            ]
          },
          "button": {
            "anyOf": [
              {},
              {
                "type": "null"
              }
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "upcoming",
              "running",
              "ended"
            ]
          },
          "display": {
            "type": "string",
            "enum": [
              "countdown",
              "hidden",
              "followUp",
              "ended"
            ]
          },
          "followUp": {
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "text": {
                "type": "string"
              },
              "link": {
                "anyOf": [
                  {},
                  {
                    "type": "null"
                  }
                ]
              }
            },
            "required": [
              "text",
              "link"
            ]
          },
          "endedText": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "label",
          "startsAt",
          "endsAt",
          "timeZone",
          "style",
          "icon",
          "button",
          "status",
          "display",
          "followUp",
          "endedText"
        ]
      },
      "Banner": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "blocks": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "One block, with its own fields beside id and type.",
              "properties": {
                "id": {
                  "type": "string"
                },
                "type": {
                  "type": "string",
                  "description": "Such as message or countdown."
                }
              },
              "required": [
                "id",
                "type"
              ]
            },
            "description": "The blocks, for guests or signed-in visitors as asked."
          },
          "text": {
            "type": "string",
            "description": "All the text, for a simple banner."
          },
          "segments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "text": {
                  "type": "string"
                },
                "highlight": {
                  "type": "boolean"
                }
              },
              "required": [
                "text",
                "highlight"
              ]
            },
            "description": "The text in parts, with the highlighted parts marked."
          },
          "link": {
            "description": "A link field: kind, href, target and label.",
            "anyOf": [
              {},
              {
                "type": "null"
              }
            ]
          },
          "background": {
            "type": "string",
            "description": "A colour, such as #1f2937."
          },
          "foreground": {
            "type": "string",
            "description": "The text colour the editor chose, or white or dark, whichever reads best on background."
          },
          "placement": {
            "type": "string",
            "enum": [
              "aboveHeader",
              "belowHeader"
            ]
          },
          "paths": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The pages it targets, with /* at the end for a whole section. Empty for every page."
          },
          "addresses": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The full addresses of those pages, with the region's prefix."
          },
          "pinned": {
            "type": "boolean"
          },
          "priority": {
            "type": "integer"
          },
          "trackingLabel": {
            "type": [
              "string",
              "null"
            ]
          },
          "countdown": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/Countdown"
              },
              {
                "type": "null"
              }
            ]
          },
          "endsAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "next": {
            "type": [
              "object",
              "null"
            ],
            "description": "The banner that takes over when this one ends.",
            "properties": {
              "id": {
                "type": "string"
              },
              "blocks": {
                "type": "array",
                "items": {
                  "type": "object",
                  "description": "One block, with its own fields beside id and type.",
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "type": {
                      "type": "string",
                      "description": "Such as message or countdown."
                    }
                  },
                  "required": [
                    "id",
                    "type"
                  ]
                },
                "description": "The blocks, for guests or signed-in visitors as asked."
              },
              "text": {
                "type": "string",
                "description": "All the text, for a simple banner."
              },
              "segments": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "text": {
                      "type": "string"
                    },
                    "highlight": {
                      "type": "boolean"
                    }
                  },
                  "required": [
                    "text",
                    "highlight"
                  ]
                },
                "description": "The text in parts, with the highlighted parts marked."
              },
              "link": {
                "description": "A link field: kind, href, target and label.",
                "anyOf": [
                  {},
                  {
                    "type": "null"
                  }
                ]
              },
              "background": {
                "type": "string",
                "description": "A colour, such as #1f2937."
              },
              "foreground": {
                "type": "string",
                "description": "The text colour the editor chose, or white or dark, whichever reads best on background."
              },
              "placement": {
                "type": "string",
                "enum": [
                  "aboveHeader",
                  "belowHeader"
                ]
              },
              "paths": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "The pages it targets, with /* at the end for a whole section. Empty for every page."
              },
              "addresses": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "The full addresses of those pages, with the region's prefix."
              },
              "pinned": {
                "type": "boolean"
              },
              "priority": {
                "type": "integer"
              },
              "trackingLabel": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "countdown": {
                "anyOf": [
                  {
                    "$ref": "#/components/schemas/Countdown"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "endsAt": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time"
              },
              "startsAt": {
                "type": "string",
                "format": "date-time"
              }
            },
            "required": [
              "id",
              "blocks",
              "text",
              "segments",
              "link",
              "background",
              "foreground",
              "placement",
              "paths",
              "addresses",
              "pinned",
              "priority",
              "trackingLabel",
              "countdown",
              "endsAt",
              "startsAt"
            ]
          }
        },
        "required": [
          "id",
          "blocks",
          "text",
          "segments",
          "link",
          "background",
          "foreground",
          "placement",
          "paths",
          "addresses",
          "pinned",
          "priority",
          "trackingLabel",
          "countdown",
          "endsAt",
          "next"
        ]
      },
      "Popup": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "layout": {
            "type": "string"
          },
          "style": {
            "type": "string"
          },
          "minimisedText": {
            "type": [
              "string",
              "null"
            ]
          },
          "blocks": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "One block, with its own fields beside id and type.",
              "properties": {
                "id": {
                  "type": "string"
                },
                "type": {
                  "type": "string",
                  "description": "Such as message or countdown."
                }
              },
              "required": [
                "id",
                "type"
              ]
            },
            "description": "The blocks, for guests or signed-in visitors as asked."
          },
          "priority": {
            "type": "integer"
          },
          "hideForDays": {
            "type": "integer",
            "description": "30 unless the editor says."
          },
          "maxViews": {
            "type": [
              "integer",
              "null"
            ]
          },
          "trackingLabel": {
            "type": [
              "string",
              "null"
            ]
          },
          "startsAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "endsAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          }
        },
        "required": [
          "id",
          "name",
          "layout",
          "style",
          "minimisedText",
          "blocks",
          "priority",
          "hideForDays",
          "maxViews",
          "trackingLabel",
          "startsAt",
          "endsAt"
        ]
      },
      "Product": {
        "type": "object",
        "properties": {
          "slug": {
            "type": "string"
          },
          "url": {
            "type": [
              "string",
              "null"
            ]
          },
          "name": {
            "type": "string"
          },
          "catalogId": {
            "type": [
              "string",
              "null"
            ],
            "description": "Links the product to the shop catalogue, which supplies price and inStock."
          },
          "size": {
            "type": [
              "string",
              "null"
            ]
          },
          "price": {
            "type": [
              "number",
              "null"
            ],
            "description": "null when the product isn't linked or the catalogue can't be reached."
          },
          "currency": {
            "type": [
              "string",
              "null"
            ]
          },
          "wasPrice": {
            "type": [
              "number",
              "null"
            ]
          },
          "inStock": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "onSale": {
            "type": "boolean"
          },
          "badges": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "benefits": {},
          "directions": {},
          "ingredients": {},
          "terms": {
            "type": [
              "string",
              "null"
            ]
          },
          "images": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "url": {
                  "type": "string"
                },
                "width": {
                  "type": [
                    "integer",
                    "null"
                  ]
                },
                "height": {
                  "type": [
                    "integer",
                    "null"
                  ]
                },
                "alt": {
                  "type": "string"
                }
              },
              "required": [
                "url",
                "width",
                "height",
                "alt"
              ]
            }
          },
          "filters": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "taxonomy": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "value": {
                  "type": "string"
                },
                "label": {
                  "type": "string"
                }
              },
              "required": [
                "taxonomy",
                "value",
                "label"
              ]
            }
          },
          "relatedSlugs": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "seo": {},
          "publishedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          }
        },
        "required": [
          "slug",
          "url",
          "name",
          "catalogId",
          "size",
          "price",
          "currency",
          "wasPrice",
          "inStock",
          "onSale",
          "badges",
          "benefits",
          "directions",
          "ingredients",
          "terms",
          "images",
          "filters",
          "relatedSlugs",
          "seo",
          "publishedAt"
        ]
      },
      "Products": {
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Product"
            }
          },
          "total": {
            "type": "integer"
          },
          "page": {
            "type": "integer"
          },
          "hasMore": {
            "type": "boolean"
          }
        },
        "required": [
          "items",
          "total",
          "page",
          "hasMore"
        ]
      },
      "SitemapIndex": {
        "type": "object",
        "properties": {
          "indexable": {
            "type": "boolean"
          },
          "sitemaps": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "region": {
                  "type": "string"
                },
                "locale": {
                  "type": "string"
                },
                "base": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "pages": {
                  "type": "integer"
                },
                "files": {
                  "type": "integer",
                  "description": "Sitemap files, up to 50,000 addresses each."
                }
              },
              "required": [
                "region",
                "locale",
                "base",
                "pages",
                "files"
              ]
            }
          }
        },
        "required": [
          "indexable",
          "sitemaps"
        ]
      },
      "Sitemap": {
        "type": "object",
        "properties": {
          "region": {
            "type": "string"
          },
          "locale": {
            "type": "string"
          },
          "page": {
            "type": "integer"
          },
          "totalPages": {
            "type": "integer"
          },
          "entries": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "loc": {
                  "type": "string"
                },
                "lastmod": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time"
                },
                "changefreq": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "priority": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "images": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "loc": {
                        "type": "string"
                      },
                      "title": {
                        "type": [
                          "string",
                          "null"
                        ]
                      }
                    },
                    "required": [
                      "loc",
                      "title"
                    ]
                  }
                },
                "alternates": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "hreflang": {
                        "type": "string"
                      },
                      "href": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "hreflang",
                      "href"
                    ]
                  }
                }
              },
              "required": [
                "loc",
                "lastmod",
                "changefreq",
                "priority",
                "images",
                "alternates"
              ]
            }
          }
        },
        "required": [
          "region",
          "locale",
          "page",
          "totalPages",
          "entries"
        ]
      }
    },
    "securitySchemes": {
      "bearer": {
        "type": "http",
        "scheme": "bearer",
        "description": "A delivery key: cms_pk_… (public) or cms_sk_… (secret, server only)."
      },
      "apiKeyHeader": {
        "type": "apiKey",
        "in": "header",
        "name": "x-api-key",
        "description": "The same key in another header."
      },
      "apiKeyQuery": {
        "type": "apiKey",
        "in": "query",
        "name": "apiKey",
        "description": "A public key only, so the CDN can cache the answer. A secret key here is refused with 401."
      }
    }
  }
}
