{
  "openapi": "3.1.0",
  "info": {
    "title": "Booking Orbit public API",
    "version": "1",
    "summary": "Services, people, free times, holds, bookings, changes and the waitlist for one location.",
    "description": "The public booking API is what the booking page, the widget and the Booking SDK use. It needs no key; changing an appointment needs its manage token, which only the customer gets. Answers are JSON in data; errors are error with a code and a message fine to show a customer.\n\nReading works from any website. Holds, bookings, the waitlist and one appointment answer only the location's allowed websites and servers. Times are ISO 8601 in UTC and money is in the currency's smallest unit. Lists come whole, with no pages.\n\nRequests are limited for each network (IP address) and location: about 120 reads a minute, 10 holds and 10 changes to one appointment a minute, and 5 bookings or waitlist sign-ups a minute, with short bursts allowed. Over the limit the answer is 429 rate_limited; no rate-limit headers are sent, so wait a minute and try again.",
    "contact": {
      "name": "Bifröst Orbit",
      "url": "https://docs.bifrostorbit.com/",
      "email": "hello@bifrostorbit.com"
    },
    "termsOfService": "https://bifrostorbit.com/legal/terms/"
  },
  "servers": [
    {
      "url": "https://app.bifrostorbit.com/booking/api/public",
      "description": "Production"
    },
    {
      "url": "https://stage.bifrostorbit.com/booking/api/public",
      "description": "Staging"
    }
  ],
  "tags": [
    {
      "name": "Location",
      "description": "The location and what the form asks."
    },
    {
      "name": "Services",
      "description": "Services and the people who take them."
    },
    {
      "name": "Free times",
      "description": "When a service can be booked."
    },
    {
      "name": "Booking",
      "description": "Holds and bookings."
    },
    {
      "name": "One appointment",
      "description": "Reading, moving and cancelling with the manage token."
    },
    {
      "name": "Waitlist",
      "description": "Joining the waitlist and reading offers."
    }
  ],
  "externalDocs": {
    "url": "https://docs.bifrostorbit.com/booking/developers/public-api/",
    "description": "The public booking API guide"
  },
  "paths": {
    "/{location}": {
      "get": {
        "operationId": "getLocation",
        "tags": [
          "Location"
        ],
        "summary": "The location",
        "description": "Name, address, time zone, languages, opening hours, policies and what the booking form asks. Cacheable for 60 seconds.",
        "parameters": [
          {
            "name": "location",
            "in": "path",
            "required": true,
            "description": "The location's short name, the last part of its booking page address.",
            "schema": {
              "type": "string"
            },
            "example": "northwilds-oslo"
          },
          {
            "name": "locale",
            "in": "query",
            "description": "A language the location offers.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The location.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/Location"
                    }
                  },
                  "required": [
                    "data"
                  ]
                },
                "example": {
                  "data": {
                    "id": "6650f1c2a9e4b1d2c3f40b01",
                    "slug": "northwilds-oslo",
                    "name": "Northwilds Oslo",
                    "description": "Our gear shop and workshop in Grünerløkka.",
                    "intro": "Book a boot fitting, a ski service or a climbing lesson with the Oslo team.",
                    "kind": "place",
                    "address": {
                      "lines": [
                        "Karl Johans gate 12"
                      ],
                      "city": "Oslo",
                      "region": "",
                      "postcode": "0154",
                      "country": "NO"
                    },
                    "timeZone": "Europe/Oslo",
                    "currency": "NOK",
                    "locales": [
                      "en",
                      "nb"
                    ],
                    "defaultLocale": "en",
                    "logoUrl": "https://northwilds.com/logo.svg",
                    "coverUrl": "https://northwilds.com/images/oslo-shop.jpg",
                    "colour": "#1f4e46",
                    "phone": "+47 22 35 10 20",
                    "email": "oslo@northwilds.com",
                    "openingHours": [
                      {
                        "day": 1,
                        "ranges": [
                          {
                            "from": "10:00",
                            "to": "18:00"
                          }
                        ]
                      },
                      {
                        "day": 2,
                        "ranges": [
                          {
                            "from": "10:00",
                            "to": "18:00"
                          }
                        ]
                      },
                      {
                        "day": 3,
                        "ranges": [
                          {
                            "from": "10:00",
                            "to": "18:00"
                          }
                        ]
                      },
                      {
                        "day": 4,
                        "ranges": [
                          {
                            "from": "10:00",
                            "to": "18:00"
                          }
                        ]
                      },
                      {
                        "day": 5,
                        "ranges": [
                          {
                            "from": "10:00",
                            "to": "18:00"
                          }
                        ]
                      },
                      {
                        "day": 6,
                        "ranges": [
                          {
                            "from": "10:00",
                            "to": "16:00"
                          }
                        ]
                      }
                    ],
                    "policies": {
                      "cancelUntilHours": 24,
                      "rescheduleUntilHours": 24,
                      "requireApproval": false
                    },
                    "bookingPage": {
                      "showStaff": true,
                      "showPrices": true,
                      "phone": "optional",
                      "notes": "optional",
                      "waitlist": true,
                      "marketing": true,
                      "termsUrl": "https://northwilds.com/terms/",
                      "privacyUrl": "https://northwilds.com/privacy/"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The location doesn't exist.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "not_found",
                    "message": "Booking page was not found"
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many tries from one network. Wait a minute.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "rate_limited",
                    "message": "Too many tries. Wait a minute and try again."
                  }
                }
              }
            }
          },
          "500": {
            "description": "Something went wrong on our side.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "server_error",
                    "message": "Something went wrong on our side. Try again in a moment."
                  }
                }
              }
            }
          }
        },
        "security": [],
        "x-try-it": {
          "run": true
        }
      }
    },
    "/{location}/services": {
      "get": {
        "operationId": "listServices",
        "tags": [
          "Services"
        ],
        "summary": "List services",
        "description": "The services listed on the booking page, in their order, all at once. Services shown only with a link are left out but can be read and booked by id or short name.",
        "parameters": [
          {
            "name": "location",
            "in": "path",
            "required": true,
            "description": "The location's short name, the last part of its booking page address.",
            "schema": {
              "type": "string"
            },
            "example": "northwilds-oslo"
          }
        ],
        "responses": {
          "200": {
            "description": "The services.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "services": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Service"
                          }
                        }
                      },
                      "required": [
                        "services"
                      ]
                    }
                  },
                  "required": [
                    "data"
                  ]
                },
                "example": {
                  "data": {
                    "services": [
                      {
                        "id": "6650f1c2a9e4b1d2c3f40b11",
                        "slug": "boot-fitting",
                        "name": "Boot fitting",
                        "description": "We measure your feet, heat-mould the liners and set up your new ski boots.",
                        "category": "Fitting",
                        "imageUrl": "https://northwilds.com/images/boot-fitting.jpg",
                        "durationMinutes": 45,
                        "mode": "in-person",
                        "price": {
                          "kind": "fixed",
                          "amount": 45000
                        },
                        "payment": {
                          "rule": "none",
                          "depositAmount": null
                        },
                        "capacity": 1,
                        "staffIds": [
                          "6650f1c2a9e4b1d2c3f40b21"
                        ],
                        "formId": "6650f1c2a9e4b1d2c3f40b31"
                      },
                      {
                        "id": "6650f1c2a9e4b1d2c3f40b12",
                        "slug": "climbing-lesson",
                        "name": "Climbing lesson",
                        "description": "Two hours on the wall with one of our guides. Shoes and harness included.",
                        "category": "Lessons",
                        "imageUrl": null,
                        "durationMinutes": 120,
                        "mode": "in-person",
                        "price": {
                          "kind": "from",
                          "amount": 60000
                        },
                        "payment": {
                          "rule": "none",
                          "depositAmount": null
                        },
                        "capacity": 6,
                        "staffIds": [],
                        "formId": null
                      }
                    ]
                  }
                }
              }
            }
          },
          "404": {
            "description": "The location doesn't exist.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "not_found",
                    "message": "Booking page was not found"
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many tries from one network. Wait a minute.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "rate_limited",
                    "message": "Too many tries. Wait a minute and try again."
                  }
                }
              }
            }
          },
          "500": {
            "description": "Something went wrong on our side.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "server_error",
                    "message": "Something went wrong on our side. Try again in a moment."
                  }
                }
              }
            }
          }
        },
        "security": [],
        "x-try-it": {
          "run": true
        }
      }
    },
    "/{location}/services/{service}": {
      "get": {
        "operationId": "getService",
        "tags": [
          "Services"
        ],
        "summary": "Get a service",
        "description": "The service, the people who take it and the questions to ask. File questions are only on the booking page.",
        "parameters": [
          {
            "name": "location",
            "in": "path",
            "required": true,
            "description": "The location's short name, the last part of its booking page address.",
            "schema": {
              "type": "string"
            },
            "example": "northwilds-oslo"
          },
          {
            "name": "service",
            "in": "path",
            "required": true,
            "description": "Id or short name.",
            "schema": {
              "type": "string"
            },
            "example": "boot-fitting"
          },
          {
            "name": "locale",
            "in": "query",
            "description": "A language the location offers.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The service.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "service": {
                          "$ref": "#/components/schemas/Service"
                        },
                        "staff": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Staff"
                          }
                        },
                        "form": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Question"
                          }
                        }
                      },
                      "required": [
                        "service",
                        "staff",
                        "form"
                      ]
                    }
                  },
                  "required": [
                    "data"
                  ]
                },
                "example": {
                  "data": {
                    "service": {
                      "id": "6650f1c2a9e4b1d2c3f40b11",
                      "slug": "boot-fitting",
                      "name": "Boot fitting",
                      "description": "We measure your feet, heat-mould the liners and set up your new ski boots.",
                      "category": "Fitting",
                      "imageUrl": "https://northwilds.com/images/boot-fitting.jpg",
                      "durationMinutes": 45,
                      "mode": "in-person",
                      "price": {
                        "kind": "fixed",
                        "amount": 45000
                      },
                      "payment": {
                        "rule": "none",
                        "depositAmount": null
                      },
                      "capacity": 1,
                      "staffIds": [
                        "6650f1c2a9e4b1d2c3f40b21"
                      ],
                      "formId": "6650f1c2a9e4b1d2c3f40b31"
                    },
                    "staff": [
                      {
                        "id": "6650f1c2a9e4b1d2c3f40b21",
                        "name": "Kari Nordmann",
                        "title": "Boot fitter",
                        "bio": "Kari has fitted ski boots in Oslo for twelve winters.",
                        "photoUrl": "https://northwilds.com/images/kari.jpg"
                      }
                    ],
                    "form": [
                      {
                        "id": "skiing",
                        "type": "choice",
                        "label": "How do you mostly ski?",
                        "help": "So Kari can set the right flex.",
                        "required": true,
                        "options": [
                          {
                            "id": "piste",
                            "label": "On piste"
                          },
                          {
                            "id": "touring",
                            "label": "Touring"
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          },
          "404": {
            "description": "The location or service doesn't exist.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "not_found",
                    "message": "Service was not found"
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many tries from one network. Wait a minute.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "rate_limited",
                    "message": "Too many tries. Wait a minute and try again."
                  }
                }
              }
            }
          },
          "500": {
            "description": "Something went wrong on our side.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "server_error",
                    "message": "Something went wrong on our side. Try again in a moment."
                  }
                }
              }
            }
          }
        },
        "security": [],
        "x-try-it": {
          "run": true
        }
      }
    },
    "/{location}/staff": {
      "get": {
        "operationId": "listStaff",
        "tags": [
          "Services"
        ],
        "summary": "List people",
        "description": "Bookable people, only those who take the service when you name one. Empty when customers can't choose a person.",
        "parameters": [
          {
            "name": "location",
            "in": "path",
            "required": true,
            "description": "The location's short name, the last part of its booking page address.",
            "schema": {
              "type": "string"
            },
            "example": "northwilds-oslo"
          },
          {
            "name": "service",
            "in": "query",
            "description": "Id or short name.",
            "schema": {
              "type": "string"
            },
            "example": "boot-fitting"
          }
        ],
        "responses": {
          "200": {
            "description": "The people.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "staff": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Staff"
                          }
                        }
                      },
                      "required": [
                        "staff"
                      ]
                    }
                  },
                  "required": [
                    "data"
                  ]
                },
                "example": {
                  "data": {
                    "staff": [
                      {
                        "id": "6650f1c2a9e4b1d2c3f40b21",
                        "name": "Kari Nordmann",
                        "title": "Boot fitter",
                        "bio": "Kari has fitted ski boots in Oslo for twelve winters.",
                        "photoUrl": "https://northwilds.com/images/kari.jpg"
                      }
                    ]
                  }
                }
              }
            }
          },
          "404": {
            "description": "The location or service doesn't exist.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "not_found",
                    "message": "Service was not found"
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many tries from one network. Wait a minute.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "rate_limited",
                    "message": "Too many tries. Wait a minute and try again."
                  }
                }
              }
            }
          },
          "500": {
            "description": "Something went wrong on our side.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "server_error",
                    "message": "Something went wrong on our side. Try again in a moment."
                  }
                }
              }
            }
          }
        },
        "security": [],
        "x-try-it": {
          "run": true
        }
      }
    },
    "/{location}/slots": {
      "get": {
        "operationId": "listSlots",
        "tags": [
          "Free times"
        ],
        "summary": "Free times",
        "description": "Every time is in UTC; send them back as you got them. The browser may cache the answer for 15 seconds. To see more days, ask again with from set to the to you got.",
        "parameters": [
          {
            "name": "location",
            "in": "path",
            "required": true,
            "description": "The location's short name, the last part of its booking page address.",
            "schema": {
              "type": "string"
            },
            "example": "northwilds-oslo"
          },
          {
            "name": "service",
            "in": "query",
            "required": true,
            "description": "Id or short name.",
            "schema": {
              "type": "string"
            },
            "example": "boot-fitting"
          },
          {
            "name": "staff",
            "in": "query",
            "description": "A person's id, for only their times.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "from",
            "in": "query",
            "description": "The first day, YYYY-MM-DD. Today if left out or in the past.",
            "schema": {
              "type": "string"
            },
            "example": "2026-11-12"
          },
          {
            "name": "days",
            "in": "query",
            "description": "1 to 42. 14 if left out.",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 42,
              "default": 14
            }
          },
          {
            "name": "timeZone",
            "in": "query",
            "description": "An IANA time zone such as Europe/Oslo, so days start at the customer's midnight.",
            "schema": {
              "type": "string"
            },
            "example": "Europe/Oslo"
          },
          {
            "name": "manage",
            "in": "query",
            "description": "The manage token of an appointment being moved, so its own time counts as free.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The free times.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/Slots"
                    }
                  },
                  "required": [
                    "data"
                  ]
                },
                "example": {
                  "data": {
                    "timeZone": "Europe/Oslo",
                    "from": "2026-11-12",
                    "to": "2026-11-14",
                    "days": [
                      {
                        "date": "2026-11-12",
                        "slots": [
                          {
                            "startsAt": "2026-11-12T09:45:00.000Z",
                            "endsAt": "2026-11-12T10:30:00.000Z",
                            "staffIds": [
                              "6650f1c2a9e4b1d2c3f40b21"
                            ],
                            "placesLeft": null
                          },
                          {
                            "startsAt": "2026-11-12T10:30:00.000Z",
                            "endsAt": "2026-11-12T11:15:00.000Z",
                            "staffIds": [
                              "6650f1c2a9e4b1d2c3f40b21"
                            ],
                            "placesLeft": null
                          }
                        ]
                      },
                      {
                        "date": "2026-11-13",
                        "slots": []
                      }
                    ],
                    "next": {
                      "startsAt": "2026-11-12T09:45:00.000Z",
                      "staffIds": [
                        "6650f1c2a9e4b1d2c3f40b21"
                      ]
                    },
                    "maxDays": 42
                  }
                }
              }
            }
          },
          "400": {
            "description": "No service.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "invalid",
                    "message": "Name the service with ?service="
                  }
                }
              }
            }
          },
          "404": {
            "description": "The location or service doesn't exist.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "not_found",
                    "message": "Service was not found"
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many tries from one network. Wait a minute.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "rate_limited",
                    "message": "Too many tries. Wait a minute and try again."
                  }
                }
              }
            }
          },
          "500": {
            "description": "Something went wrong on our side.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "server_error",
                    "message": "Something went wrong on our side. Try again in a moment."
                  }
                }
              }
            }
          }
        },
        "security": [],
        "x-try-it": {
          "run": true
        }
      }
    },
    "/{location}/holds": {
      "post": {
        "operationId": "hold",
        "tags": [
          "Booking"
        ],
        "summary": "Hold a time",
        "description": "Holds the time for 10 minutes while the customer fills in the form. Without staff, Booking Orbit picks a free person.",
        "parameters": [
          {
            "name": "location",
            "in": "path",
            "required": true,
            "description": "The location's short name, the last part of its booking page address.",
            "schema": {
              "type": "string"
            },
            "example": "northwilds-oslo"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "service": {
                    "type": "string"
                  },
                  "staff": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "startsAt": {
                    "type": "string",
                    "format": "date-time"
                  }
                },
                "required": [
                  "service",
                  "startsAt"
                ]
              },
              "example": {
                "service": "boot-fitting",
                "startsAt": "2026-11-12T09:45:00.000Z"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The hold.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "token": {
                          "type": "string"
                        },
                        "expiresAt": {
                          "type": "string",
                          "format": "date-time"
                        },
                        "staffId": {
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "staffName": {
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "required": [
                        "token",
                        "expiresAt",
                        "staffId",
                        "staffName"
                      ]
                    }
                  },
                  "required": [
                    "data"
                  ]
                },
                "example": {
                  "data": {
                    "token": "h7Kp3QzW9mVt2RxLc5NdYbFe",
                    "expiresAt": "2026-11-10T14:10:00.000Z",
                    "staffId": "6650f1c2a9e4b1d2c3f40b21",
                    "staffName": "Kari Nordmann"
                  }
                }
              }
            }
          },
          "402": {
            "description": "The location is paused because the plan has ended.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "subscription_inactive",
                    "message": "This location is paused because its Booking Orbit trial or plan has ended. Nothing is deleted, and it comes back as soon as an owner chooses a plan."
                  }
                }
              }
            }
          },
          "403": {
            "description": "A change from a website that isn't allowed.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "forbidden",
                    "message": "This website isn't allowed to book here. Add it to the allowed websites in Booking Orbit's settings."
                  }
                }
              }
            }
          },
          "404": {
            "description": "The location doesn't exist.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "not_found",
                    "message": "Booking page was not found"
                  }
                }
              }
            }
          },
          "409": {
            "description": "The time has just gone, or the service is paid online when booked (payment_required, with bookingUrl).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "conflict",
                    "message": "That time is already taken"
                  }
                }
              }
            }
          },
          "422": {
            "description": "A field is missing or wrong.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "invalid",
                    "message": "Enter a valid email address",
                    "issues": [
                      {
                        "code": "invalid_format",
                        "path": [
                          "email"
                        ],
                        "message": "Enter a valid email address"
                      }
                    ]
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many tries from one network.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "rate_limited",
                    "message": "Too many tries. Wait a minute and try again."
                  }
                }
              }
            }
          },
          "500": {
            "description": "Something went wrong on our side.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "server_error",
                    "message": "Something went wrong on our side. Try again in a moment."
                  }
                }
              }
            }
          }
        },
        "security": [],
        "x-try-it": {
          "run": false,
          "reason": "It holds a real time at the location."
        }
      }
    },
    "/{location}/holds/{token}": {
      "delete": {
        "operationId": "release",
        "tags": [
          "Booking"
        ],
        "summary": "Let a held time go",
        "description": "Answers { released: true }, also for a hold that had already run out.",
        "parameters": [
          {
            "name": "location",
            "in": "path",
            "required": true,
            "description": "The location's short name, the last part of its booking page address.",
            "schema": {
              "type": "string"
            },
            "example": "northwilds-oslo"
          },
          {
            "name": "token",
            "in": "path",
            "required": true,
            "description": "The hold's token.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Released.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "released": {
                          "const": true
                        }
                      },
                      "required": [
                        "released"
                      ]
                    }
                  },
                  "required": [
                    "data"
                  ]
                },
                "example": {
                  "data": {
                    "released": true
                  }
                }
              }
            }
          },
          "402": {
            "description": "The location is paused because the plan has ended.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "subscription_inactive",
                    "message": "This location is paused because its Booking Orbit trial or plan has ended. Nothing is deleted, and it comes back as soon as an owner chooses a plan."
                  }
                }
              }
            }
          },
          "403": {
            "description": "A change from a website that isn't allowed.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "forbidden",
                    "message": "This website isn't allowed to book here. Add it to the allowed websites in Booking Orbit's settings."
                  }
                }
              }
            }
          },
          "404": {
            "description": "The location doesn't exist.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "not_found",
                    "message": "Booking page was not found"
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many tries from one network.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "rate_limited",
                    "message": "Too many tries. Wait a minute and try again."
                  }
                }
              }
            }
          },
          "500": {
            "description": "Something went wrong on our side.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "server_error",
                    "message": "Something went wrong on our side. Try again in a moment."
                  }
                }
              }
            }
          }
        },
        "security": [],
        "x-try-it": {
          "run": false,
          "reason": "It needs a real hold."
        }
      }
    },
    "/{location}/appointments": {
      "post": {
        "operationId": "book",
        "tags": [
          "Booking"
        ],
        "summary": "Book an appointment",
        "description": "Status is confirmed, or pending when the location confirms bookings itself. A service paid online when booked (a deposit, the full price or a saved card) can't be booked through the API: the answer is 409 payment_required with bookingUrl, the hosted booking page where the customer books and pays. The same person can book a limited number of times a day when the location sets a limit.",
        "parameters": [
          {
            "name": "location",
            "in": "path",
            "required": true,
            "description": "The location's short name, the last part of its booking page address.",
            "schema": {
              "type": "string"
            },
            "example": "northwilds-oslo"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BookingInput"
              },
              "example": {
                "service": "boot-fitting",
                "staff": "6650f1c2a9e4b1d2c3f40b21",
                "startsAt": "2026-11-12T09:45:00.000Z",
                "holdToken": "h7Kp3QzW9mVt2RxLc5NdYbFe",
                "name": "Ingrid Berg",
                "email": "ingrid@northwilds.com",
                "phone": "+47 912 34 567",
                "answers": {
                  "skiing": "touring"
                },
                "marketing": false,
                "locale": "en",
                "timeZone": "Europe/Oslo"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The appointment and how it is paid.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "appointment": {
                          "$ref": "#/components/schemas/Appointment"
                        },
                        "payment": {
                          "$ref": "#/components/schemas/Payment"
                        }
                      },
                      "required": [
                        "appointment",
                        "payment"
                      ]
                    }
                  },
                  "required": [
                    "data"
                  ]
                },
                "example": {
                  "data": {
                    "appointment": {
                      "reference": "29BMJM",
                      "status": "confirmed",
                      "service": {
                        "id": "6650f1c2a9e4b1d2c3f40b11",
                        "slug": "boot-fitting",
                        "name": "Boot fitting",
                        "durationMinutes": 45,
                        "mode": "in-person"
                      },
                      "staff": "Kari Nordmann",
                      "startsAt": "2026-11-12T09:45:00.000Z",
                      "endsAt": "2026-11-12T10:30:00.000Z",
                      "timeZone": "Europe/Oslo",
                      "attendee": {
                        "name": "Ingrid Berg",
                        "email": "ingrid@northwilds.com"
                      },
                      "manageUrl": "https://app.bifrostorbit.com/booking/m/q8Xv2LrT0pYk3NwZs7AeHbUc",
                      "calendar": {
                        "ics": "/booking/api/public/northwilds-oslo/manage/q8Xv2LrT0pYk3NwZs7AeHbUc/calendar",
                        "google": "https://calendar.google.com/calendar/render?action=TEMPLATE&text=Boot%20fitting",
                        "outlook": "https://outlook.live.com/calendar/0/deeplink/compose?subject=Boot%20fitting"
                      },
                      "canChange": true,
                      "changeUntil": "2026-11-11T09:45:00.000Z",
                      "cancelReason": null,
                      "meetingUrl": null,
                      "location": {
                        "name": "Northwilds Oslo",
                        "slug": "northwilds-oslo",
                        "address": "Karl Johans gate 12, 0154 Oslo",
                        "online": false,
                        "phone": "+47 22 35 10 20",
                        "email": "oslo@northwilds.com"
                      }
                    },
                    "payment": {
                      "required": false,
                      "method": "at-location",
                      "rule": null,
                      "amount": 45000,
                      "currency": "NOK",
                      "manageToken": null,
                      "url": null
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "An answer doesn't fit its question, or a required phone number is missing.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "invalid",
                    "message": "Choose an answer for ‘How do you mostly ski?’"
                  }
                }
              }
            }
          },
          "402": {
            "description": "The location is paused because the plan has ended.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "subscription_inactive",
                    "message": "This location is paused because its Booking Orbit trial or plan has ended. Nothing is deleted, and it comes back as soon as an owner chooses a plan."
                  }
                }
              }
            }
          },
          "403": {
            "description": "A change from a website that isn't allowed.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "forbidden",
                    "message": "This website isn't allowed to book here. Add it to the allowed websites in Booking Orbit's settings."
                  }
                }
              }
            }
          },
          "404": {
            "description": "The location doesn't exist.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "not_found",
                    "message": "Booking page was not found"
                  }
                }
              }
            }
          },
          "409": {
            "description": "The time has gone, the hold ran out, a daily limit was reached, or the service is paid online when booked (payment_required, with bookingUrl).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "payment_required",
                    "message": "This service is paid online when it's booked, so book it on the booking page.",
                    "rule": "deposit",
                    "bookingUrl": "https://app.bifrostorbit.com/booking/b/northwilds-oslo?service=boot-fitting&start=2026-11-12T09%3A45%3A00.000Z"
                  }
                }
              }
            }
          },
          "422": {
            "description": "A field is missing or wrong.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "invalid",
                    "message": "Enter a valid email address",
                    "issues": [
                      {
                        "code": "invalid_format",
                        "path": [
                          "email"
                        ],
                        "message": "Enter a valid email address"
                      }
                    ]
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many tries from one network.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "rate_limited",
                    "message": "Too many tries. Wait a minute and try again."
                  }
                }
              }
            }
          },
          "500": {
            "description": "Something went wrong on our side.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "server_error",
                    "message": "Something went wrong on our side. Try again in a moment."
                  }
                }
              }
            }
          }
        },
        "security": [],
        "x-try-it": {
          "run": false,
          "reason": "It books a real appointment and emails the customer."
        }
      }
    },
    "/{location}/manage/{token}": {
      "get": {
        "operationId": "getAppointment",
        "tags": [
          "One appointment"
        ],
        "summary": "Read an appointment",
        "description": "As booking answers. canChange says whether the customer may still move or cancel it online.",
        "parameters": [
          {
            "name": "location",
            "in": "path",
            "required": true,
            "description": "The location's short name, the last part of its booking page address.",
            "schema": {
              "type": "string"
            },
            "example": "northwilds-oslo"
          },
          {
            "name": "token",
            "in": "path",
            "required": true,
            "description": "The manage token, the last part of manageUrl.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "locale",
            "in": "query",
            "description": "A language the location offers.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The appointment.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "appointment": {
                          "$ref": "#/components/schemas/Appointment"
                        }
                      },
                      "required": [
                        "appointment"
                      ]
                    }
                  },
                  "required": [
                    "data"
                  ]
                },
                "example": {
                  "data": {
                    "appointment": {
                      "reference": "29BMJM",
                      "status": "confirmed",
                      "service": {
                        "id": "6650f1c2a9e4b1d2c3f40b11",
                        "slug": "boot-fitting",
                        "name": "Boot fitting",
                        "durationMinutes": 45,
                        "mode": "in-person"
                      },
                      "staff": "Kari Nordmann",
                      "startsAt": "2026-11-12T09:45:00.000Z",
                      "endsAt": "2026-11-12T10:30:00.000Z",
                      "timeZone": "Europe/Oslo",
                      "attendee": {
                        "name": "Ingrid Berg",
                        "email": "ingrid@northwilds.com"
                      },
                      "manageUrl": "https://app.bifrostorbit.com/booking/m/q8Xv2LrT0pYk3NwZs7AeHbUc",
                      "calendar": {
                        "ics": "/booking/api/public/northwilds-oslo/manage/q8Xv2LrT0pYk3NwZs7AeHbUc/calendar",
                        "google": "https://calendar.google.com/calendar/render?action=TEMPLATE&text=Boot%20fitting",
                        "outlook": "https://outlook.live.com/calendar/0/deeplink/compose?subject=Boot%20fitting"
                      },
                      "canChange": true,
                      "changeUntil": "2026-11-11T09:45:00.000Z",
                      "cancelReason": null,
                      "meetingUrl": null,
                      "location": {
                        "name": "Northwilds Oslo",
                        "slug": "northwilds-oslo",
                        "address": "Karl Johans gate 12, 0154 Oslo",
                        "online": false,
                        "phone": "+47 22 35 10 20",
                        "email": "oslo@northwilds.com"
                      }
                    }
                  }
                }
              }
            }
          },
          "402": {
            "description": "The location is paused because the plan has ended.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "subscription_inactive",
                    "message": "This location is paused because its Booking Orbit trial or plan has ended. Nothing is deleted, and it comes back as soon as an owner chooses a plan."
                  }
                }
              }
            }
          },
          "403": {
            "description": "A change from a website that isn't allowed.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "forbidden",
                    "message": "This website isn't allowed to book here. Add it to the allowed websites in Booking Orbit's settings."
                  }
                }
              }
            }
          },
          "404": {
            "description": "No appointment with that token.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "not_found",
                    "message": "Appointment was not found"
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many tries from one network.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "rate_limited",
                    "message": "Too many tries. Wait a minute and try again."
                  }
                }
              }
            }
          },
          "500": {
            "description": "Something went wrong on our side.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "server_error",
                    "message": "Something went wrong on our side. Try again in a moment."
                  }
                }
              }
            }
          }
        },
        "security": [],
        "x-try-it": {
          "run": false,
          "reason": "It needs a customer's manage token."
        }
      }
    },
    "/{location}/manage/{token}/reschedule": {
      "post": {
        "operationId": "reschedule",
        "tags": [
          "One appointment"
        ],
        "summary": "Move an appointment",
        "description": "Find times with GET /slots?manage=<token>. Without staff, it stays with the same person if they are free.",
        "parameters": [
          {
            "name": "location",
            "in": "path",
            "required": true,
            "description": "The location's short name, the last part of its booking page address.",
            "schema": {
              "type": "string"
            },
            "example": "northwilds-oslo"
          },
          {
            "name": "token",
            "in": "path",
            "required": true,
            "description": "The manage token, the last part of manageUrl.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "startsAt": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "staff": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "locale": {
                    "type": "string"
                  }
                },
                "required": [
                  "startsAt"
                ]
              },
              "example": {
                "startsAt": "2026-11-13T13:00:00.000Z",
                "locale": "en"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The appointment.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "appointment": {
                          "$ref": "#/components/schemas/Appointment"
                        }
                      },
                      "required": [
                        "appointment"
                      ]
                    }
                  },
                  "required": [
                    "data"
                  ]
                },
                "example": {
                  "data": {
                    "appointment": {
                      "reference": "29BMJM",
                      "status": "confirmed",
                      "service": {
                        "id": "6650f1c2a9e4b1d2c3f40b11",
                        "slug": "boot-fitting",
                        "name": "Boot fitting",
                        "durationMinutes": 45,
                        "mode": "in-person"
                      },
                      "staff": "Kari Nordmann",
                      "startsAt": "2026-11-13T13:00:00.000Z",
                      "endsAt": "2026-11-13T13:45:00.000Z",
                      "timeZone": "Europe/Oslo",
                      "attendee": {
                        "name": "Ingrid Berg",
                        "email": "ingrid@northwilds.com"
                      },
                      "manageUrl": "https://app.bifrostorbit.com/booking/m/q8Xv2LrT0pYk3NwZs7AeHbUc",
                      "calendar": {
                        "ics": "/booking/api/public/northwilds-oslo/manage/q8Xv2LrT0pYk3NwZs7AeHbUc/calendar",
                        "google": "https://calendar.google.com/calendar/render?action=TEMPLATE&text=Boot%20fitting",
                        "outlook": "https://outlook.live.com/calendar/0/deeplink/compose?subject=Boot%20fitting"
                      },
                      "canChange": true,
                      "changeUntil": "2026-11-12T13:00:00.000Z",
                      "cancelReason": null,
                      "meetingUrl": null,
                      "location": {
                        "name": "Northwilds Oslo",
                        "slug": "northwilds-oslo",
                        "address": "Karl Johans gate 12, 0154 Oslo",
                        "online": false,
                        "phone": "+47 22 35 10 20",
                        "email": "oslo@northwilds.com"
                      }
                    }
                  }
                }
              }
            }
          },
          "402": {
            "description": "The location is paused because the plan has ended.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "subscription_inactive",
                    "message": "This location is paused because its Booking Orbit trial or plan has ended. Nothing is deleted, and it comes back as soon as an owner chooses a plan."
                  }
                }
              }
            }
          },
          "403": {
            "description": "Too close to the start, or a website that isn't allowed.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "forbidden",
                    "message": "It's too late to move this appointment online. Contact the location to change it."
                  }
                }
              }
            }
          },
          "404": {
            "description": "No appointment with that token.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "not_found",
                    "message": "Appointment was not found"
                  }
                }
              }
            }
          },
          "409": {
            "description": "The time has gone.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "conflict",
                    "message": "That time is already taken"
                  }
                }
              }
            }
          },
          "422": {
            "description": "startsAt is missing or isn't a time.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "invalid",
                    "message": "Invalid ISO datetime",
                    "issues": [
                      {
                        "code": "invalid_format",
                        "path": [
                          "startsAt"
                        ],
                        "message": "Invalid ISO datetime"
                      }
                    ]
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many tries from one network.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "rate_limited",
                    "message": "Too many tries. Wait a minute and try again."
                  }
                }
              }
            }
          },
          "500": {
            "description": "Something went wrong on our side.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "server_error",
                    "message": "Something went wrong on our side. Try again in a moment."
                  }
                }
              }
            }
          }
        },
        "security": [],
        "x-try-it": {
          "run": false,
          "reason": "It moves a real appointment."
        }
      }
    },
    "/{location}/manage/{token}/cancel": {
      "post": {
        "operationId": "cancel",
        "tags": [
          "One appointment"
        ],
        "summary": "Cancel an appointment",
        "description": "reason is optional, up to 500 characters.",
        "parameters": [
          {
            "name": "location",
            "in": "path",
            "required": true,
            "description": "The location's short name, the last part of its booking page address.",
            "schema": {
              "type": "string"
            },
            "example": "northwilds-oslo"
          },
          {
            "name": "token",
            "in": "path",
            "required": true,
            "description": "The manage token, the last part of manageUrl.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "reason": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "maxLength": 500
                  },
                  "locale": {
                    "type": "string"
                  }
                },
                "required": []
              },
              "example": {
                "reason": "I've caught a cold, sorry.",
                "locale": "en"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The appointment.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "appointment": {
                          "$ref": "#/components/schemas/Appointment"
                        }
                      },
                      "required": [
                        "appointment"
                      ]
                    }
                  },
                  "required": [
                    "data"
                  ]
                },
                "example": {
                  "data": {
                    "appointment": {
                      "reference": "29BMJM",
                      "status": "cancelled",
                      "service": {
                        "id": "6650f1c2a9e4b1d2c3f40b11",
                        "slug": "boot-fitting",
                        "name": "Boot fitting",
                        "durationMinutes": 45,
                        "mode": "in-person"
                      },
                      "staff": "Kari Nordmann",
                      "startsAt": "2026-11-12T09:45:00.000Z",
                      "endsAt": "2026-11-12T10:30:00.000Z",
                      "timeZone": "Europe/Oslo",
                      "attendee": {
                        "name": "Ingrid Berg",
                        "email": "ingrid@northwilds.com"
                      },
                      "manageUrl": "https://app.bifrostorbit.com/booking/m/q8Xv2LrT0pYk3NwZs7AeHbUc",
                      "calendar": {
                        "ics": "/booking/api/public/northwilds-oslo/manage/q8Xv2LrT0pYk3NwZs7AeHbUc/calendar",
                        "google": "https://calendar.google.com/calendar/render?action=TEMPLATE&text=Boot%20fitting",
                        "outlook": "https://outlook.live.com/calendar/0/deeplink/compose?subject=Boot%20fitting"
                      },
                      "canChange": false,
                      "changeUntil": "2026-11-11T09:45:00.000Z",
                      "cancelReason": "I've caught a cold, sorry.",
                      "meetingUrl": null,
                      "location": {
                        "name": "Northwilds Oslo",
                        "slug": "northwilds-oslo",
                        "address": "Karl Johans gate 12, 0154 Oslo",
                        "online": false,
                        "phone": "+47 22 35 10 20",
                        "email": "oslo@northwilds.com"
                      }
                    }
                  }
                }
              }
            }
          },
          "402": {
            "description": "The location is paused because the plan has ended.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "subscription_inactive",
                    "message": "This location is paused because its Booking Orbit trial or plan has ended. Nothing is deleted, and it comes back as soon as an owner chooses a plan."
                  }
                }
              }
            }
          },
          "403": {
            "description": "Too close to the start, or a website that isn't allowed.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "forbidden",
                    "message": "It's too late to cancel this appointment online. Contact the location to cancel it."
                  }
                }
              }
            }
          },
          "404": {
            "description": "No appointment with that token.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "not_found",
                    "message": "Appointment was not found"
                  }
                }
              }
            }
          },
          "409": {
            "description": "Over or already cancelled.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "conflict",
                    "message": "This appointment is already over or cancelled"
                  }
                }
              }
            }
          },
          "422": {
            "description": "The reason is over 500 characters.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "invalid",
                    "message": "Too big: expected string to have <=500 characters",
                    "issues": [
                      {
                        "code": "too_big",
                        "path": [
                          "reason"
                        ],
                        "message": "Too big: expected string to have <=500 characters"
                      }
                    ]
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many tries from one network.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "rate_limited",
                    "message": "Too many tries. Wait a minute and try again."
                  }
                }
              }
            }
          },
          "500": {
            "description": "Something went wrong on our side.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "server_error",
                    "message": "Something went wrong on our side. Try again in a moment."
                  }
                }
              }
            }
          }
        },
        "security": [],
        "x-try-it": {
          "run": false,
          "reason": "It cancels a real appointment."
        }
      }
    },
    "/{location}/manage/{token}/calendar": {
      "get": {
        "operationId": "calendar",
        "tags": [
          "One appointment"
        ],
        "summary": "Calendar file",
        "description": "The appointment as a calendar file, named after its reference, such as 29BMJM.ics.",
        "parameters": [
          {
            "name": "location",
            "in": "path",
            "required": true,
            "description": "The location's short name, the last part of its booking page address.",
            "schema": {
              "type": "string"
            },
            "example": "northwilds-oslo"
          },
          {
            "name": "token",
            "in": "path",
            "required": true,
            "description": "The manage token, the last part of manageUrl.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The calendar file.",
            "content": {
              "text/calendar": {
                "schema": {
                  "type": "string"
                },
                "example": "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nBEGIN:VEVENT\r\nSUMMARY:Boot fitting\r\nDTSTART:20261112T094500Z\r\nDTEND:20261112T103000Z\r\nLOCATION:Northwilds Oslo, Karl Johans gate 12, 0154 Oslo\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n"
              }
            }
          },
          "404": {
            "description": "No appointment with that token.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "not_found",
                    "message": "Appointment was not found"
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many tries from one network. Wait a minute.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "rate_limited",
                    "message": "Too many tries. Wait a minute and try again."
                  }
                }
              }
            }
          },
          "500": {
            "description": "Something went wrong on our side.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "server_error",
                    "message": "Something went wrong on our side. Try again in a moment."
                  }
                }
              }
            }
          }
        },
        "security": [],
        "x-try-it": {
          "run": false,
          "reason": "It needs a customer's manage token."
        }
      }
    },
    "/{location}/waitlist": {
      "post": {
        "operationId": "joinWaitlist",
        "tags": [
          "Waitlist"
        ],
        "summary": "Join the waitlist",
        "description": "For up to 90 days. Joining again for the same service replaces the days. When a time frees up, the customer gets an offer by email.",
        "parameters": [
          {
            "name": "location",
            "in": "path",
            "required": true,
            "description": "The location's short name, the last part of its booking page address.",
            "schema": {
              "type": "string"
            },
            "example": "northwilds-oslo"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "service": {
                    "type": "string"
                  },
                  "staff": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "from": {
                    "type": "string",
                    "description": "YYYY-MM-DD."
                  },
                  "to": {
                    "type": "string",
                    "description": "YYYY-MM-DD."
                  },
                  "name": {
                    "type": "string",
                    "maxLength": 120
                  },
                  "email": {
                    "type": "string",
                    "format": "email"
                  },
                  "phone": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "locale": {
                    "type": "string"
                  },
                  "timeZone": {
                    "type": "string"
                  }
                },
                "required": [
                  "service",
                  "from",
                  "to",
                  "name",
                  "email"
                ]
              },
              "example": {
                "service": "climbing-lesson",
                "from": "2026-11-10",
                "to": "2026-11-20",
                "name": "Ingrid Berg",
                "email": "ingrid@northwilds.com",
                "locale": "en",
                "timeZone": "Europe/Oslo"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Joined.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "joined": {
                          "const": true
                        }
                      },
                      "required": [
                        "joined"
                      ]
                    }
                  },
                  "required": [
                    "data"
                  ]
                },
                "example": {
                  "data": {
                    "joined": true
                  }
                }
              }
            }
          },
          "402": {
            "description": "The location is paused because the plan has ended.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "subscription_inactive",
                    "message": "This location is paused because its Booking Orbit trial or plan has ended. Nothing is deleted, and it comes back as soon as an owner chooses a plan."
                  }
                }
              }
            }
          },
          "403": {
            "description": "The location doesn't keep a waitlist, or a website that isn't allowed.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "forbidden",
                    "message": "This location doesn't keep a waitlist."
                  }
                }
              }
            }
          },
          "404": {
            "description": "The location doesn't exist.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "not_found",
                    "message": "Booking page was not found"
                  }
                }
              }
            }
          },
          "422": {
            "description": "A field is missing or wrong.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "invalid",
                    "message": "Enter a valid email address",
                    "issues": [
                      {
                        "code": "invalid_format",
                        "path": [
                          "email"
                        ],
                        "message": "Enter a valid email address"
                      }
                    ]
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many tries from one network.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "rate_limited",
                    "message": "Too many tries. Wait a minute and try again."
                  }
                }
              }
            }
          },
          "500": {
            "description": "Something went wrong on our side.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "server_error",
                    "message": "Something went wrong on our side. Try again in a moment."
                  }
                }
              }
            }
          }
        },
        "security": [],
        "x-try-it": {
          "run": false,
          "reason": "It puts a real person on the waitlist."
        }
      }
    },
    "/{location}/offers/{token}": {
      "get": {
        "operationId": "getOffer",
        "tags": [
          "Waitlist"
        ],
        "summary": "Read a waitlist offer",
        "description": "To book it, send POST /appointments with the offer's token as holdToken.",
        "parameters": [
          {
            "name": "location",
            "in": "path",
            "required": true,
            "description": "The location's short name, the last part of its booking page address.",
            "schema": {
              "type": "string"
            },
            "example": "northwilds-oslo"
          },
          {
            "name": "token",
            "in": "path",
            "required": true,
            "description": "The token from the offer email.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The offer.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "offer": {
                          "$ref": "#/components/schemas/Offer"
                        }
                      },
                      "required": [
                        "offer"
                      ]
                    }
                  },
                  "required": [
                    "data"
                  ]
                },
                "example": {
                  "data": {
                    "offer": {
                      "token": "h7Kp3QzW9mVt2RxLc5NdYbFe",
                      "service": {
                        "id": "6650f1c2a9e4b1d2c3f40b12",
                        "slug": "climbing-lesson",
                        "name": "Climbing lesson",
                        "durationMinutes": 120
                      },
                      "staffId": null,
                      "staff": null,
                      "startsAt": "2026-11-14T15:00:00.000Z",
                      "expiresAt": "2026-11-11T09:00:00.000Z",
                      "customer": {
                        "name": "Ingrid Berg",
                        "email": "ingrid@northwilds.com",
                        "phone": null
                      }
                    }
                  }
                }
              }
            }
          },
          "402": {
            "description": "The location is paused because the plan has ended.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "subscription_inactive",
                    "message": "This location is paused because its Booking Orbit trial or plan has ended. Nothing is deleted, and it comes back as soon as an owner chooses a plan."
                  }
                }
              }
            }
          },
          "403": {
            "description": "A change from a website that isn't allowed.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "forbidden",
                    "message": "This website isn't allowed to book here. Add it to the allowed websites in Booking Orbit's settings."
                  }
                }
              }
            }
          },
          "404": {
            "description": "The offer has run out or was taken.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "not_found",
                    "message": "Offer was not found"
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many tries from one network.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "rate_limited",
                    "message": "Too many tries. Wait a minute and try again."
                  }
                }
              }
            }
          },
          "500": {
            "description": "Something went wrong on our side.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "error": {
                    "code": "server_error",
                    "message": "Something went wrong on our side. Try again in a moment."
                  }
                }
              }
            }
          }
        },
        "security": [],
        "x-try-it": {
          "run": false,
          "reason": "It needs a token from a real offer email."
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Error": {
        "type": "object",
        "properties": {
          "error": {
            "type": "object",
            "properties": {
              "code": {
                "type": "string",
                "description": "invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable."
              },
              "message": {
                "type": "string",
                "description": "In English, fine to show to a customer."
              },
              "rule": {
                "type": "string",
                "description": "With payment_required: deposit, full or card-on-file."
              },
              "bookingUrl": {
                "type": "string",
                "description": "With payment_required: the service on the hosted booking page, with the person and time you asked for, where the customer can book and pay."
              },
              "issues": {
                "type": "array",
                "items": {},
                "description": "On 422: the fields that failed, each with its path and message."
              }
            },
            "required": [
              "code",
              "message"
            ]
          }
        },
        "required": [
          "error"
        ]
      },
      "Location": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "slug": {
            "type": "string",
            "description": "Such as northwilds-oslo."
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "intro": {
            "type": "string",
            "description": "In the language asked for."
          },
          "kind": {
            "type": "string",
            "enum": [
              "place",
              "online"
            ]
          },
          "address": {
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "lines": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "city": {
                "type": "string"
              },
              "region": {
                "type": "string"
              },
              "postcode": {
                "type": "string"
              },
              "country": {
                "type": "string"
              }
            },
            "required": [
              "lines",
              "city",
              "region",
              "postcode",
              "country"
            ]
          },
          "timeZone": {
            "type": "string",
            "description": "Such as Europe/Oslo."
          },
          "currency": {
            "type": "string"
          },
          "locales": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "defaultLocale": {
            "type": "string"
          },
          "logoUrl": {
            "type": [
              "string",
              "null"
            ]
          },
          "coverUrl": {
            "type": [
              "string",
              "null"
            ]
          },
          "colour": {
            "type": [
              "string",
              "null"
            ]
          },
          "phone": {
            "type": [
              "string",
              "null"
            ]
          },
          "email": {
            "type": [
              "string",
              "null"
            ]
          },
          "openingHours": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "day": {
                  "type": "integer",
                  "description": "0 for Sunday to 6 for Saturday.",
                  "minimum": 0,
                  "maximum": 6
                },
                "ranges": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "from": {
                        "type": "string",
                        "description": "Such as 09:00."
                      },
                      "to": {
                        "type": "string",
                        "description": "Such as 17:00."
                      }
                    },
                    "required": [
                      "from",
                      "to"
                    ]
                  }
                }
              },
              "required": [
                "day",
                "ranges"
              ]
            },
            "description": "One entry per open weekday, in the location's time zone."
          },
          "policies": {
            "type": "object",
            "properties": {
              "cancelUntilHours": {
                "type": "integer",
                "description": "Customers may cancel online until this many hours before."
              },
              "rescheduleUntilHours": {
                "type": "integer",
                "description": "Customers may move online until this many hours before."
              },
              "requireApproval": {
                "type": "boolean",
                "description": "New bookings wait for the team to confirm them."
              }
            },
            "required": [
              "cancelUntilHours",
              "rescheduleUntilHours",
              "requireApproval"
            ]
          },
          "bookingPage": {
            "type": "object",
            "description": "How to build the booking form.",
            "properties": {
              "showStaff": {
                "type": "boolean",
                "description": "Customers may choose a person. If false, staff is empty."
              },
              "showPrices": {
                "type": "boolean",
                "description": "If false, every price is { kind: hidden, amount: null }."
              },
              "phone": {
                "type": "string",
                "enum": [
                  "required",
                  "optional",
                  "hidden"
                ]
              },
              "notes": {
                "type": "string",
                "enum": [
                  "required",
                  "optional",
                  "hidden"
                ]
              },
              "waitlist": {
                "type": "boolean"
              },
              "marketing": {
                "type": "boolean",
                "description": "Ask whether the customer wants news; send the answer as marketing."
              },
              "termsUrl": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "privacyUrl": {
                "type": [
                  "string",
                  "null"
                ]
              }
            },
            "required": [
              "showStaff",
              "showPrices",
              "phone",
              "notes",
              "waitlist",
              "marketing",
              "termsUrl",
              "privacyUrl"
            ]
          }
        },
        "required": [
          "id",
          "slug",
          "name",
          "description",
          "intro",
          "kind",
          "address",
          "timeZone",
          "currency",
          "locales",
          "defaultLocale",
          "logoUrl",
          "coverUrl",
          "colour",
          "phone",
          "email",
          "openingHours",
          "policies",
          "bookingPage"
        ]
      },
      "Service": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "slug": {
            "type": "string",
            "description": "Such as boot-fitting."
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "category": {
            "type": [
              "string",
              "null"
            ]
          },
          "imageUrl": {
            "type": [
              "string",
              "null"
            ]
          },
          "durationMinutes": {
            "type": "integer"
          },
          "mode": {
            "type": "string",
            "enum": [
              "in-person",
              "online",
              "either"
            ]
          },
          "price": {
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "enum": [
                  "free",
                  "fixed",
                  "from",
                  "hidden"
                ]
              },
              "amount": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "The price. In the currency's smallest unit, so 45000 with NOK is NOK 450."
              }
            },
            "required": [
              "kind",
              "amount"
            ]
          },
          "payment": {
            "type": "object",
            "properties": {
              "rule": {
                "type": "string",
                "enum": [
                  "none",
                  "deposit",
                  "full"
                ]
              },
              "depositAmount": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "The deposit. In the currency's smallest unit, so 45000 with NOK is NOK 450."
              }
            },
            "required": [
              "rule",
              "depositAmount"
            ]
          },
          "capacity": {
            "type": "integer",
            "description": "Places in one session. Above 1, several customers book the same time."
          },
          "staffIds": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The people who take it. Empty means anyone."
          },
          "formId": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "id",
          "slug",
          "name",
          "description",
          "category",
          "imageUrl",
          "durationMinutes",
          "mode",
          "price",
          "payment",
          "capacity",
          "staffIds",
          "formId"
        ]
      },
      "Staff": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "title": {
            "type": [
              "string",
              "null"
            ]
          },
          "bio": {
            "type": "string"
          },
          "photoUrl": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "id",
          "name",
          "title",
          "bio",
          "photoUrl"
        ]
      },
      "Question": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The key in answers."
          },
          "type": {
            "type": "string",
            "enum": [
              "short-text",
              "long-text",
              "number",
              "choice",
              "choices",
              "yes-no",
              "date",
              "consent",
              "file"
            ]
          },
          "label": {
            "type": "string"
          },
          "help": {
            "type": "string"
          },
          "required": {
            "type": "boolean"
          },
          "options": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "label": {
                  "type": "string"
                }
              },
              "required": [
                "id",
                "label"
              ]
            }
          }
        },
        "required": [
          "id",
          "type",
          "label",
          "help",
          "required",
          "options"
        ]
      },
      "Slots": {
        "type": "object",
        "properties": {
          "timeZone": {
            "type": "string"
          },
          "from": {
            "type": "string",
            "description": "The first day, YYYY-MM-DD."
          },
          "to": {
            "type": "string",
            "description": "The day after the last one."
          },
          "days": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "date": {
                  "type": "string"
                },
                "slots": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "startsAt": {
                        "type": "string",
                        "format": "date-time"
                      },
                      "endsAt": {
                        "type": "string",
                        "format": "date-time"
                      },
                      "staffIds": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        },
                        "description": "The people free then."
                      },
                      "placesLeft": {
                        "type": [
                          "integer",
                          "null"
                        ],
                        "description": "Free places, for services with more than one."
                      }
                    },
                    "required": [
                      "startsAt",
                      "endsAt",
                      "staffIds",
                      "placesLeft"
                    ]
                  }
                }
              },
              "required": [
                "date",
                "slots"
              ]
            },
            "description": "Every day, with an empty slots when nothing is free."
          },
          "next": {
            "type": [
              "object",
              "null"
            ],
            "description": "The first free time, looked for beyond your days too.",
            "properties": {
              "startsAt": {
                "type": "string",
                "format": "date-time"
              },
              "staffIds": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "required": [
              "startsAt",
              "staffIds"
            ]
          },
          "maxDays": {
            "type": "integer",
            "description": "The most days one call can ask for."
          }
        },
        "required": [
          "timeZone",
          "from",
          "to",
          "days",
          "next",
          "maxDays"
        ]
      },
      "Appointment": {
        "type": "object",
        "properties": {
          "reference": {
            "type": "string",
            "description": "Such as 29BMJM."
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "confirmed",
              "checked-in",
              "completed",
              "cancelled",
              "no-show"
            ]
          },
          "service": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "slug": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "durationMinutes": {
                "type": "integer"
              },
              "mode": {
                "type": "string",
                "enum": [
                  "in-person",
                  "online",
                  "either"
                ]
              }
            },
            "required": [
              "id",
              "slug",
              "name",
              "durationMinutes",
              "mode"
            ]
          },
          "staff": {
            "type": [
              "string",
              "null"
            ]
          },
          "startsAt": {
            "type": "string",
            "format": "date-time"
          },
          "endsAt": {
            "type": "string",
            "format": "date-time"
          },
          "timeZone": {
            "type": "string"
          },
          "attendee": {
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "name": {
                "type": "string"
              },
              "email": {
                "type": [
                  "string",
                  "null"
                ]
              }
            },
            "required": [
              "name",
              "email"
            ]
          },
          "manageUrl": {
            "type": "string",
            "description": "The customer's own page for it. Its last part is the manage token: anyone with it can move or cancel the appointment."
          },
          "calendar": {
            "type": "object",
            "properties": {
              "ics": {
                "type": "string",
                "description": "A path on the Booking Orbit address."
              },
              "google": {
                "type": "string"
              },
              "outlook": {
                "type": "string"
              }
            },
            "required": [
              "ics",
              "google",
              "outlook"
            ]
          },
          "canChange": {
            "type": "boolean",
            "description": "Whether the customer may still move or cancel it online."
          },
          "changeUntil": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "cancelReason": {
            "type": [
              "string",
              "null"
            ]
          },
          "meetingUrl": {
            "type": [
              "string",
              "null"
            ],
            "description": "The video link for an online appointment, once there is one."
          },
          "location": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "slug": {
                "type": "string"
              },
              "address": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "online": {
                "type": "boolean"
              },
              "phone": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "email": {
                "type": [
                  "string",
                  "null"
                ]
              }
            },
            "required": [
              "name",
              "slug",
              "address",
              "online",
              "phone",
              "email"
            ]
          }
        },
        "required": [
          "reference",
          "status",
          "service",
          "staff",
          "startsAt",
          "endsAt",
          "timeZone",
          "attendee",
          "manageUrl",
          "calendar",
          "canChange",
          "changeUntil",
          "cancelReason",
          "meetingUrl",
          "location"
        ]
      },
      "Payment": {
        "type": "object",
        "properties": {
          "required": {
            "type": "boolean",
            "description": "True when the customer pays online now. Only the booking page and the widget take payments, so the API answers 409 payment_required for these services instead of booking them."
          },
          "method": {
            "type": "string",
            "enum": [
              "none",
              "at-location",
              "online"
            ]
          },
          "rule": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "deposit",
              "full",
              "card-on-file",
              null
            ]
          },
          "amount": {
            "type": [
              "integer",
              "null"
            ],
            "description": "What is due. In the currency's smallest unit, so 45000 with NOK is NOK 450."
          },
          "currency": {
            "type": "string"
          },
          "manageToken": {
            "type": [
              "string",
              "null"
            ]
          },
          "url": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "required",
          "method",
          "rule",
          "amount",
          "currency",
          "manageToken",
          "url"
        ]
      },
      "Offer": {
        "type": "object",
        "properties": {
          "token": {
            "type": "string",
            "description": "Send as holdToken to book it."
          },
          "service": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "slug": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "durationMinutes": {
                "type": "integer"
              }
            },
            "required": [
              "id",
              "slug",
              "name",
              "durationMinutes"
            ]
          },
          "staffId": {
            "type": [
              "string",
              "null"
            ]
          },
          "staff": {
            "type": [
              "string",
              "null"
            ]
          },
          "startsAt": {
            "type": "string",
            "format": "date-time"
          },
          "expiresAt": {
            "type": "string",
            "format": "date-time"
          },
          "customer": {
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "name": {
                "type": "string"
              },
              "email": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "phone": {
                "type": [
                  "string",
                  "null"
                ]
              }
            },
            "required": [
              "name",
              "email",
              "phone"
            ]
          }
        },
        "required": [
          "token",
          "service",
          "staffId",
          "staff",
          "startsAt",
          "expiresAt",
          "customer"
        ]
      },
      "BookingInput": {
        "type": "object",
        "properties": {
          "service": {
            "type": "string",
            "description": "Id or short name."
          },
          "staff": {
            "type": [
              "string",
              "null"
            ]
          },
          "startsAt": {
            "type": "string",
            "format": "date-time"
          },
          "holdToken": {
            "type": [
              "string",
              "null"
            ],
            "description": "Recommended. Booking fails with 409 if the hold has run out or is for another time."
          },
          "name": {
            "type": "string",
            "maxLength": 120
          },
          "email": {
            "type": "string",
            "description": "The confirmation and reminders go here.",
            "format": "email",
            "maxLength": 200
          },
          "phone": {
            "type": [
              "string",
              "null"
            ],
            "description": "Required when bookingPage.phone is required.",
            "maxLength": 40
          },
          "notes": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 2000
          },
          "answers": {
            "type": "object",
            "additionalProperties": {},
            "description": "By question id: option ids for choice and choices, true or false for yes-no and consent, YYYY-MM-DD for date."
          },
          "marketing": {
            "type": "boolean"
          },
          "locale": {
            "type": "string",
            "description": "For the customer's emails."
          },
          "timeZone": {
            "type": "string",
            "description": "For the customer's emails."
          }
        },
        "required": [
          "service",
          "startsAt",
          "name",
          "email"
        ]
      }
    },
    "securitySchemes": {}
  }
}
