Skip to content

Booking Orbit public API

Services, people, free times, holds, bookings, changes and the waitlist for one location.

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.

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

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

Read the guideOpenAPI 3.1 document

Try it settings

https://app.bifrostorbit.com/booking/api/public

The public booking API needs no key, so Try it sends reads as they are.

Try it sends each request straight from your browser to the API. The key stays in this page's memory: it is never saved, never sent to docs.bifrostorbit.com and gone when you leave or reload the page. Only reads are run; anything that changes data is described and never sent.

LocationThe location and what the form asks.

The location

GET/{location}No key

Name, address, time zone, languages, opening hours, policies and what the booking form asks. Cacheable for 60 seconds.

Parameters

  • locationstringpath, required

    The location's short name, the last part of its booking page address.

  • localestringquery

    A language the location offers.

Responses

  • 200OKThe location.
    • dataLocation

      Fields of data
      • idstring

      • slugstring

        Such as northwilds-oslo.

      • namestring

      • descriptionstring

      • introstring

        In the language asked for.

      • kindstring

        One of place, online.
      • addressobject or null

        Fields of address
        • linesstring[]

        • citystring

        • regionstring

        • postcodestring

        • countrystring

      • timeZonestring

        Such as Europe/Oslo.

      • currencystring

      • localesstring[]

      • defaultLocalestring

      • logoUrlstring or null

      • coverUrlstring or null

      • colourstring or null

      • phonestring or null

      • emailstring or null

      • openingHoursobject[]

        One entry per open weekday, in the location's time zone.

        Fields of openingHours
        • dayinteger

          0 for Sunday to 6 for Saturday.

          At least 0. At most 6.
        • rangesobject[]

          Fields of ranges
          • fromstring

            Such as 09:00.

          • tostring

            Such as 17:00.

      • policiesobject

        Fields of policies
        • cancelUntilHoursinteger

          Customers may cancel online until this many hours before.

        • rescheduleUntilHoursinteger

          Customers may move online until this many hours before.

        • requireApprovalboolean

          New bookings wait for the team to confirm them.

      • bookingPageobject

        How to build the booking form.

        Fields of bookingPage
        • showStaffboolean

          Customers may choose a person. If false, staff is empty.

        • showPricesboolean

          If false, every price is { kind: hidden, amount: null }.

        • phonestring

          One of required, optional, hidden.
        • notesstring

          One of required, optional, hidden.
        • waitlistboolean

        • marketingboolean

          Ask whether the customer wants news; send the answer as marketing.

        • termsUrlstring or null

        • privacyUrlstring or null

  • 404Not foundThe location doesn't exist.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 429Too many requestsToo many tries from one network. Wait a minute.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

Shell
curl 'https://app.bifrostorbit.com/booking/api/public/northwilds-oslo'

Try it

Example answer

200 OKJSON
{  "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/"    }  }}

ServicesServices and the people who take them.

List services

GET/{location}/servicesNo key

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

  • locationstringpath, required

    The location's short name, the last part of its booking page address.

Responses

  • 200OKThe services.
  • 404Not foundThe location doesn't exist.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 429Too many requestsToo many tries from one network. Wait a minute.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

Shell
curl 'https://app.bifrostorbit.com/booking/api/public/northwilds-oslo/services'

Try it

Example answer

200 OKJSON
{  "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      }    ]  }}

Get a service

GET/{location}/services/{service}No key

The service, the people who take it and the questions to ask. File questions are only on the booking page.

Parameters

  • locationstringpath, required

    The location's short name, the last part of its booking page address.

  • servicestringpath, required

    Id or short name.

  • localestringquery

    A language the location offers.

Responses

  • 200OKThe service.
  • 404Not foundThe location or service doesn't exist.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 429Too many requestsToo many tries from one network. Wait a minute.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

Shell
curl 'https://app.bifrostorbit.com/booking/api/public/northwilds-oslo/services/boot-fitting'

Try it

Example answer

200 OKJSON
{  "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"          }        ]      }    ]  }}

List people

GET/{location}/staffNo key

Bookable people, only those who take the service when you name one. Empty when customers can't choose a person.

Parameters

  • locationstringpath, required

    The location's short name, the last part of its booking page address.

  • servicestringquery

    Id or short name.

Responses

  • 200OKThe people.
  • 404Not foundThe location or service doesn't exist.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 429Too many requestsToo many tries from one network. Wait a minute.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

Shell
curl 'https://app.bifrostorbit.com/booking/api/public/northwilds-oslo/staff'

Try it

Example answer

200 OKJSON
{  "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"      }    ]  }}

Free timesWhen a service can be booked.

Free times

GET/{location}/slotsNo key

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

  • locationstringpath, required

    The location's short name, the last part of its booking page address.

  • servicestringquery, required

    Id or short name.

  • staffstringquery

    A person's id, for only their times.

  • fromstringquery

    The first day, YYYY-MM-DD. Today if left out or in the past.

  • daysintegerquery

    1 to 42. 14 if left out.

    Default 14. At least 1. At most 42.
  • timeZonestringquery

    An IANA time zone such as Europe/Oslo, so days start at the customer's midnight.

  • managestringquery

    The manage token of an appointment being moved, so its own time counts as free.

Responses

  • 200OKThe free times.
    • dataSlots

      Fields of data
      • timeZonestring

      • fromstring

        The first day, YYYY-MM-DD.

      • tostring

        The day after the last one.

      • daysobject[]

        Every day, with an empty slots when nothing is free.

        Fields of days
        • datestring

        • slotsobject[]

          Fields of slots
          • startsAtstring

          • endsAtstring

          • staffIdsstring[]

            The people free then.

          • placesLeftinteger or null

            Free places, for services with more than one.

      • nextobject or null

        The first free time, looked for beyond your days too.

        Fields of next
        • startsAtstring

        • staffIdsstring[]

      • maxDaysinteger

        The most days one call can ask for.

  • 400Bad requestNo service.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 404Not foundThe location or service doesn't exist.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 429Too many requestsToo many tries from one network. Wait a minute.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

Shell
curl 'https://app.bifrostorbit.com/booking/api/public/northwilds-oslo/slots?service=boot-fitting'

Try it

Example answer

200 OKJSON
{  "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  }}

BookingHolds and bookings.

Hold a time

POST/{location}/holdsNo key

Holds the time for 10 minutes while the customer fills in the form. Without staff, Booking Orbit picks a free person.

Parameters

  • locationstringpath, required

    The location's short name, the last part of its booking page address.

Request body

  • servicestringrequired

  • staffstring or nulloptional

  • startsAtstringrequired

Responses

  • 201CreatedThe hold.
    • dataobject

      Fields of data
      • tokenstring

      • expiresAtstring

      • staffIdstring or null

      • staffNamestring or null

  • 402Payment requiredThe location is paused because the plan has ended.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 403ForbiddenA change from a website that isn't allowed.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 404Not foundThe location doesn't exist.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 409ConflictThe time has just gone, or the service is paid online when booked (payment_required, with bookingUrl).
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 422UnprocessableA field is missing or wrong.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 429Too many requestsToo many tries from one network.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

Shell
curl -X POST 'https://app.bifrostorbit.com/booking/api/public/northwilds-oslo/holds' \  -H 'Content-Type: application/json' \  -d '{"service":"boot-fitting","startsAt":"2026-11-12T09:45:00.000Z"}'

Try it

It holds a real time at the location.

Example answer

201 CreatedJSON
{  "data": {    "token": "h7Kp3QzW9mVt2RxLc5NdYbFe",    "expiresAt": "2026-11-10T14:10:00.000Z",    "staffId": "6650f1c2a9e4b1d2c3f40b21",    "staffName": "Kari Nordmann"  }}

Let a held time go

DELETE/{location}/holds/{token}No key

Answers { released: true }, also for a hold that had already run out.

Parameters

  • locationstringpath, required

    The location's short name, the last part of its booking page address.

  • tokenstringpath, required

    The hold's token.

Responses

  • 200OKReleased.
    • dataobject

      Fields of data
      • releasedtrue

  • 402Payment requiredThe location is paused because the plan has ended.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 403ForbiddenA change from a website that isn't allowed.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 404Not foundThe location doesn't exist.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 429Too many requestsToo many tries from one network.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

Shell
curl -X DELETE 'https://app.bifrostorbit.com/booking/api/public/northwilds-oslo/holds/%7Btoken%7D'

Try it

It needs a real hold.

Example answer

200 OKJSON
{  "data": {    "released": true  }}

Book an appointment

POST/{location}/appointmentsNo key

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

  • locationstringpath, required

    The location's short name, the last part of its booking page address.

Request body

  • servicestringrequired

    Id or short name.

  • staffstring or nulloptional

  • startsAtstringrequired

  • holdTokenstring or nulloptional

    Recommended. Booking fails with 409 if the hold has run out or is for another time.

  • namestringrequired

    Up to 120 characters.
  • emailstringrequired

    The confirmation and reminders go here.

    Up to 200 characters.
  • phonestring or nulloptional

    Required when bookingPage.phone is required.

    Up to 40 characters.
  • notesstring or nulloptional

    Up to 2000 characters.
  • answersmap of anyoptional

    By question id: option ids for choice and choices, true or false for yes-no and consent, YYYY-MM-DD for date.

  • marketingbooleanoptional

  • localestringoptional

    For the customer's emails.

  • timeZonestringoptional

    For the customer's emails.

Responses

  • 201CreatedThe appointment and how it is paid.
  • 400Bad requestAn answer doesn't fit its question, or a required phone number is missing.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 402Payment requiredThe location is paused because the plan has ended.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 403ForbiddenA change from a website that isn't allowed.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 404Not foundThe location doesn't exist.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 409ConflictThe time has gone, the hold ran out, a daily limit was reached, or the service is paid online when booked (payment_required, with bookingUrl).
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 422UnprocessableA field is missing or wrong.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 429Too many requestsToo many tries from one network.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

Shell
curl -X POST 'https://app.bifrostorbit.com/booking/api/public/northwilds-oslo/appointments' \  -H 'Content-Type: application/json' \  -d '{"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"}'

Try it

It books a real appointment and emails the customer.

Example answer

201 CreatedJSON
{  "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    }  }}

One appointmentReading, moving and cancelling with the manage token.

Read an appointment

GET/{location}/manage/{token}No key

As booking answers. canChange says whether the customer may still move or cancel it online.

Parameters

  • locationstringpath, required

    The location's short name, the last part of its booking page address.

  • tokenstringpath, required

    The manage token, the last part of manageUrl.

  • localestringquery

    A language the location offers.

Responses

  • 200OKThe appointment.
  • 402Payment requiredThe location is paused because the plan has ended.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 403ForbiddenA change from a website that isn't allowed.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 404Not foundNo appointment with that token.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 429Too many requestsToo many tries from one network.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

Shell
curl 'https://app.bifrostorbit.com/booking/api/public/northwilds-oslo/manage/%7Btoken%7D'

Try it

It needs a customer's manage token.

Example answer

200 OKJSON
{  "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"      }    }  }}

Move an appointment

POST/{location}/manage/{token}/rescheduleNo key

Find times with GET /slots?manage=<token>. Without staff, it stays with the same person if they are free.

Parameters

  • locationstringpath, required

    The location's short name, the last part of its booking page address.

  • tokenstringpath, required

    The manage token, the last part of manageUrl.

Request body

  • startsAtstringrequired

  • staffstring or nulloptional

  • localestringoptional

Responses

  • 200OKThe appointment.
  • 402Payment requiredThe location is paused because the plan has ended.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 403ForbiddenToo close to the start, or a website that isn't allowed.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 404Not foundNo appointment with that token.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 409ConflictThe time has gone.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 422UnprocessablestartsAt is missing or isn't a time.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 429Too many requestsToo many tries from one network.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

Shell
curl -X POST 'https://app.bifrostorbit.com/booking/api/public/northwilds-oslo/manage/%7Btoken%7D/reschedule' \  -H 'Content-Type: application/json' \  -d '{"startsAt":"2026-11-13T13:00:00.000Z","locale":"en"}'

Try it

It moves a real appointment.

Example answer

200 OKJSON
{  "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"      }    }  }}

Cancel an appointment

POST/{location}/manage/{token}/cancelNo key

reason is optional, up to 500 characters.

Parameters

  • locationstringpath, required

    The location's short name, the last part of its booking page address.

  • tokenstringpath, required

    The manage token, the last part of manageUrl.

Request body

  • reasonstring or nulloptional

    Up to 500 characters.
  • localestringoptional

Responses

  • 200OKThe appointment.
  • 402Payment requiredThe location is paused because the plan has ended.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 403ForbiddenToo close to the start, or a website that isn't allowed.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 404Not foundNo appointment with that token.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 409ConflictOver or already cancelled.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 422UnprocessableThe reason is over 500 characters.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 429Too many requestsToo many tries from one network.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

Shell
curl -X POST 'https://app.bifrostorbit.com/booking/api/public/northwilds-oslo/manage/%7Btoken%7D/cancel' \  -H 'Content-Type: application/json' \  -d '{"reason":"I'\''ve caught a cold, sorry.","locale":"en"}'

Try it

It cancels a real appointment.

Example answer

200 OKJSON
{  "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"      }    }  }}

Calendar file

GET/{location}/manage/{token}/calendarNo key

The appointment as a calendar file, named after its reference, such as 29BMJM.ics.

Parameters

  • locationstringpath, required

    The location's short name, the last part of its booking page address.

  • tokenstringpath, required

    The manage token, the last part of manageUrl.

Responses

  • 200OKThe calendar file.

    text/calendar

  • 404Not foundNo appointment with that token.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 429Too many requestsToo many tries from one network. Wait a minute.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

Shell
curl 'https://app.bifrostorbit.com/booking/api/public/northwilds-oslo/manage/%7Btoken%7D/calendar'

Try it

It needs a customer's manage token.

Example answer

200 OKJSON
"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"

WaitlistJoining the waitlist and reading offers.

Join the waitlist

POST/{location}/waitlistNo key

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

  • locationstringpath, required

    The location's short name, the last part of its booking page address.

Request body

  • servicestringrequired

  • staffstring or nulloptional

  • fromstringrequired

    YYYY-MM-DD.

  • tostringrequired

    YYYY-MM-DD.

  • namestringrequired

    Up to 120 characters.
  • emailstringrequired

  • phonestring or nulloptional

  • localestringoptional

  • timeZonestringoptional

Responses

  • 201CreatedJoined.
    • dataobject

      Fields of data
      • joinedtrue

  • 402Payment requiredThe location is paused because the plan has ended.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 403ForbiddenThe location doesn't keep a waitlist, or a website that isn't allowed.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 404Not foundThe location doesn't exist.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 422UnprocessableA field is missing or wrong.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 429Too many requestsToo many tries from one network.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

Shell
curl -X POST 'https://app.bifrostorbit.com/booking/api/public/northwilds-oslo/waitlist' \  -H 'Content-Type: application/json' \  -d '{"service":"climbing-lesson","from":"2026-11-10","to":"2026-11-20","name":"Ingrid Berg","email":"ingrid@northwilds.com","locale":"en","timeZone":"Europe/Oslo"}'

Try it

It puts a real person on the waitlist.

Example answer

201 CreatedJSON
{  "data": {    "joined": true  }}

Read a waitlist offer

GET/{location}/offers/{token}No key

To book it, send POST /appointments with the offer's token as holdToken.

Parameters

  • locationstringpath, required

    The location's short name, the last part of its booking page address.

  • tokenstringpath, required

    The token from the offer email.

Responses

  • 200OKThe offer.
  • 402Payment requiredThe location is paused because the plan has ended.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 403ForbiddenA change from a website that isn't allowed.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 404Not foundThe offer has run out or was taken.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 429Too many requestsToo many tries from one network.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

      • messagestring

        In English, fine to show to a customer.

      • rulestringsometimes

        With payment_required: deposit, full or card-on-file.

      • bookingUrlstringsometimes

        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.

      • issuesany[]sometimes

        On 422: the fields that failed, each with its path and message.

Shell
curl 'https://app.bifrostorbit.com/booking/api/public/northwilds-oslo/offers/%7Btoken%7D'

Try it

It needs a token from a real offer email.

Example answer

200 OKJSON
{  "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      }    }  }}

SchemasThe shapes the endpoints above answer with and take.

Error

  • errorobject

    Fields of error
    • codestring

      invalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.

    • messagestring

      In English, fine to show to a customer.

    • rulestringsometimes

      With payment_required: deposit, full or card-on-file.

    • bookingUrlstringsometimes

      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.

    • issuesany[]sometimes

      On 422: the fields that failed, each with its path and message.

Location

  • idstring

  • slugstring

    Such as northwilds-oslo.

  • namestring

  • descriptionstring

  • introstring

    In the language asked for.

  • kindstring

    One of place, online.
  • addressobject or null

    Fields of address
    • linesstring[]

    • citystring

    • regionstring

    • postcodestring

    • countrystring

  • timeZonestring

    Such as Europe/Oslo.

  • currencystring

  • localesstring[]

  • defaultLocalestring

  • logoUrlstring or null

  • coverUrlstring or null

  • colourstring or null

  • phonestring or null

  • emailstring or null

  • openingHoursobject[]

    One entry per open weekday, in the location's time zone.

    Fields of openingHours
    • dayinteger

      0 for Sunday to 6 for Saturday.

      At least 0. At most 6.
    • rangesobject[]

      Fields of ranges
      • fromstring

        Such as 09:00.

      • tostring

        Such as 17:00.

  • policiesobject

    Fields of policies
    • cancelUntilHoursinteger

      Customers may cancel online until this many hours before.

    • rescheduleUntilHoursinteger

      Customers may move online until this many hours before.

    • requireApprovalboolean

      New bookings wait for the team to confirm them.

  • bookingPageobject

    How to build the booking form.

    Fields of bookingPage
    • showStaffboolean

      Customers may choose a person. If false, staff is empty.

    • showPricesboolean

      If false, every price is { kind: hidden, amount: null }.

    • phonestring

      One of required, optional, hidden.
    • notesstring

      One of required, optional, hidden.
    • waitlistboolean

    • marketingboolean

      Ask whether the customer wants news; send the answer as marketing.

    • termsUrlstring or null

    • privacyUrlstring or null

Service

  • idstring

  • slugstring

    Such as boot-fitting.

  • namestring

  • descriptionstring

  • categorystring or null

  • imageUrlstring or null

  • durationMinutesinteger

  • modestring

    One of in-person, online, either.
  • priceobject

    Fields of price
    • kindstring

      One of free, fixed, from, hidden.
    • amountinteger or null

      The price. In the currency's smallest unit, so 45000 with NOK is NOK 450.

  • paymentobject

    Fields of payment
    • rulestring

      One of none, deposit, full.
    • depositAmountinteger or null

      The deposit. In the currency's smallest unit, so 45000 with NOK is NOK 450.

  • capacityinteger

    Places in one session. Above 1, several customers book the same time.

  • staffIdsstring[]

    The people who take it. Empty means anyone.

  • formIdstring or null

Staff

  • idstring

  • namestring

  • titlestring or null

  • biostring

  • photoUrlstring or null

Question

  • idstring

    The key in answers.

  • typestring

    One of short-text, long-text, number, choice, choices, yes-no, date, consent, file.
  • labelstring

  • helpstring

  • requiredboolean

  • optionsobject[]

    Fields of options
    • idstring

    • labelstring

Slots

  • timeZonestring

  • fromstring

    The first day, YYYY-MM-DD.

  • tostring

    The day after the last one.

  • daysobject[]

    Every day, with an empty slots when nothing is free.

    Fields of days
    • datestring

    • slotsobject[]

      Fields of slots
      • startsAtstring

      • endsAtstring

      • staffIdsstring[]

        The people free then.

      • placesLeftinteger or null

        Free places, for services with more than one.

  • nextobject or null

    The first free time, looked for beyond your days too.

    Fields of next
    • startsAtstring

    • staffIdsstring[]

  • maxDaysinteger

    The most days one call can ask for.

Appointment

  • referencestring

    Such as 29BMJM.

  • statusstring

    One of pending, confirmed, checked-in, completed, cancelled, no-show.
  • serviceobject

    Fields of service
    • idstring

    • slugstring

    • namestring

    • durationMinutesinteger

    • modestring

      One of in-person, online, either.
  • staffstring or null

  • startsAtstring

  • endsAtstring

  • timeZonestring

  • attendeeobject or null

    Fields of attendee
    • namestring

    • emailstring or null

  • manageUrlstring

    The customer's own page for it. Its last part is the manage token: anyone with it can move or cancel the appointment.

  • calendarobject

    Fields of calendar
    • icsstring

      A path on the Booking Orbit address.

    • googlestring

    • outlookstring

  • canChangeboolean

    Whether the customer may still move or cancel it online.

  • changeUntilstring or null

  • cancelReasonstring or null

  • meetingUrlstring or null

    The video link for an online appointment, once there is one.

  • locationobject

    Fields of location
    • namestring

    • slugstring

    • addressstring or null

    • onlineboolean

    • phonestring or null

    • emailstring or null

Payment

  • requiredboolean

    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.

  • methodstring

    One of none, at-location, online.
  • rulestring or null

    One of deposit, full, card-on-file.
  • amountinteger or null

    What is due. In the currency's smallest unit, so 45000 with NOK is NOK 450.

  • currencystring

  • manageTokenstring or null

  • urlstring or null

Offer

  • tokenstring

    Send as holdToken to book it.

  • serviceobject

    Fields of service
    • idstring

    • slugstring

    • namestring

    • durationMinutesinteger

  • staffIdstring or null

  • staffstring or null

  • startsAtstring

  • expiresAtstring

  • customerobject or null

    Fields of customer
    • namestring

    • emailstring or null

    • phonestring or null

BookingInput

  • servicestring

    Id or short name.

  • staffstring or nullsometimes

  • startsAtstring

  • holdTokenstring or nullsometimes

    Recommended. Booking fails with 409 if the hold has run out or is for another time.

  • namestring

    Up to 120 characters.
  • emailstring

    The confirmation and reminders go here.

    Up to 200 characters.
  • phonestring or nullsometimes

    Required when bookingPage.phone is required.

    Up to 40 characters.
  • notesstring or nullsometimes

    Up to 2000 characters.
  • answersmap of anysometimes

    By question id: option ids for choice and choices, true or false for yes-no and consent, YYYY-MM-DD for date.

  • marketingbooleansometimes

  • localestringsometimes

    For the customer's emails.

  • timeZonestringsometimes

    For the customer's emails.