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, requiredThe location's short name, the last part of its booking page address.
localestringqueryA language the location offers.
Responses
200OKThe location.dataLocationFields of data
idstringslugstringSuch as northwilds-oslo.
namestringdescriptionstringintrostringIn the language asked for.
One of place, online.kindstringaddressobject or nullFields of address
linesstring[]citystringregionstringpostcodestringcountrystring
timeZonestringSuch as Europe/Oslo.
currencystringlocalesstring[]defaultLocalestringlogoUrlstring or nullcoverUrlstring or nullcolourstring or nullphonestring or nullemailstring or nullopeningHoursobject[]One entry per open weekday, in the location's time zone.
Fields of openingHours
dayinteger0 for Sunday to 6 for Saturday.
At least 0. At most 6.rangesobject[]Fields of ranges
fromstringSuch as 09:00.
tostringSuch as 17:00.
policiesobjectFields of policies
cancelUntilHoursintegerCustomers may cancel online until this many hours before.
rescheduleUntilHoursintegerCustomers may move online until this many hours before.
requireApprovalbooleanNew bookings wait for the team to confirm them.
bookingPageobjectHow to build the booking form.
Fields of bookingPage
showStaffbooleanCustomers may choose a person. If false, staff is empty.
showPricesbooleanIf false, every price is { kind: hidden, amount: null }.
One of required, optional, hidden.phonestring
One of required, optional, hidden.notesstringwaitlistbooleanmarketingbooleanAsk whether the customer wants news; send the answer as marketing.
termsUrlstring or nullprivacyUrlstring or null
404Not foundThe location doesn't exist.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
429Too many requestsToo many tries from one network. Wait a minute.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
500Server errorSomething went wrong on our side.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
curl 'https://app.bifrostorbit.com/booking/api/public/northwilds-oslo'Try it
Example answer
{ "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, requiredThe location's short name, the last part of its booking page address.
Responses
200OKThe services.dataobjectFields of data
servicesService[]
404Not foundThe location doesn't exist.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
429Too many requestsToo many tries from one network. Wait a minute.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
500Server errorSomething went wrong on our side.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
curl 'https://app.bifrostorbit.com/booking/api/public/northwilds-oslo/services'Try it
Example answer
{ "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, requiredThe location's short name, the last part of its booking page address.
servicestringpath, requiredId or short name.
localestringqueryA language the location offers.
Responses
200OKThe service.dataobjectFields of data
serviceServicestaffStaff[]formQuestion[]
404Not foundThe location or service doesn't exist.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
429Too many requestsToo many tries from one network. Wait a minute.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
500Server errorSomething went wrong on our side.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
curl 'https://app.bifrostorbit.com/booking/api/public/northwilds-oslo/services/boot-fitting'Try it
Example answer
{ "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, requiredThe location's short name, the last part of its booking page address.
servicestringqueryId or short name.
Responses
200OKThe people.dataobjectFields of data
staffStaff[]
404Not foundThe location or service doesn't exist.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
429Too many requestsToo many tries from one network. Wait a minute.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
500Server errorSomething went wrong on our side.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
curl 'https://app.bifrostorbit.com/booking/api/public/northwilds-oslo/staff'Try it
Example answer
{ "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, requiredThe location's short name, the last part of its booking page address.
servicestringquery, requiredId or short name.
staffstringqueryA person's id, for only their times.
fromstringqueryThe first day, YYYY-MM-DD. Today if left out or in the past.
daysintegerquery1 to 42. 14 if left out.
Default 14. At least 1. At most 42.timeZonestringqueryAn IANA time zone such as Europe/Oslo, so days start at the customer's midnight.
managestringqueryThe manage token of an appointment being moved, so its own time counts as free.
Responses
200OKThe free times.dataSlotsFields of data
timeZonestringfromstringThe first day, YYYY-MM-DD.
tostringThe day after the last one.
daysobject[]Every day, with an empty slots when nothing is free.
Fields of days
datestringslotsobject[]Fields of slots
startsAtstringendsAtstringstaffIdsstring[]The people free then.
placesLeftinteger or nullFree places, for services with more than one.
nextobject or nullThe first free time, looked for beyond your days too.
Fields of next
startsAtstringstaffIdsstring[]
maxDaysintegerThe most days one call can ask for.
400Bad requestNo service.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
404Not foundThe location or service doesn't exist.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
429Too many requestsToo many tries from one network. Wait a minute.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
500Server errorSomething went wrong on our side.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
curl 'https://app.bifrostorbit.com/booking/api/public/northwilds-oslo/slots?service=boot-fitting'Try it
Example answer
{ "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, requiredThe location's short name, the last part of its booking page address.
Request body
servicestringrequiredstaffstring or nulloptionalstartsAtstringrequired
Responses
201CreatedThe hold.dataobjectFields of data
tokenstringexpiresAtstringstaffIdstring or nullstaffNamestring or null
402Payment requiredThe location is paused because the plan has ended.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
403ForbiddenA change from a website that isn't allowed.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
404Not foundThe location doesn't exist.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 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).errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
422UnprocessableA field is missing or wrong.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
429Too many requestsToo many tries from one network.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
500Server errorSomething went wrong on our side.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
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
{ "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, requiredThe location's short name, the last part of its booking page address.
tokenstringpath, requiredThe hold's token.
Responses
200OKReleased.dataobjectFields of data
releasedtrue
402Payment requiredThe location is paused because the plan has ended.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
403ForbiddenA change from a website that isn't allowed.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
404Not foundThe location doesn't exist.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
429Too many requestsToo many tries from one network.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
500Server errorSomething went wrong on our side.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
curl -X DELETE 'https://app.bifrostorbit.com/booking/api/public/northwilds-oslo/holds/%7Btoken%7D'Try it
It needs a real hold.
Example answer
{ "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, requiredThe location's short name, the last part of its booking page address.
Request body
servicestringrequiredId or short name.
staffstring or nulloptionalstartsAtstringrequiredholdTokenstring or nulloptionalRecommended. Booking fails with 409 if the hold has run out or is for another time.
Up to 120 characters.namestringrequiredemailstringrequiredThe confirmation and reminders go here.
Up to 200 characters.phonestring or nulloptionalRequired when bookingPage.phone is required.
Up to 40 characters.
Up to 2000 characters.notesstring or nulloptionalanswersmap of anyoptionalBy question id: option ids for choice and choices, true or false for yes-no and consent, YYYY-MM-DD for date.
marketingbooleanoptionallocalestringoptionalFor the customer's emails.
timeZonestringoptionalFor the customer's emails.
Responses
201CreatedThe appointment and how it is paid.dataobjectFields of data
appointmentAppointmentpaymentPayment
400Bad requestAn answer doesn't fit its question, or a required phone number is missing.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
402Payment requiredThe location is paused because the plan has ended.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
403ForbiddenA change from a website that isn't allowed.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
404Not foundThe location doesn't exist.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 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).errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
422UnprocessableA field is missing or wrong.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
429Too many requestsToo many tries from one network.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
500Server errorSomething went wrong on our side.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
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
{ "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, requiredThe location's short name, the last part of its booking page address.
tokenstringpath, requiredThe manage token, the last part of manageUrl.
localestringqueryA language the location offers.
Responses
200OKThe appointment.dataobjectFields of data
appointmentAppointment
402Payment requiredThe location is paused because the plan has ended.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
403ForbiddenA change from a website that isn't allowed.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
404Not foundNo appointment with that token.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
429Too many requestsToo many tries from one network.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
500Server errorSomething went wrong on our side.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
curl 'https://app.bifrostorbit.com/booking/api/public/northwilds-oslo/manage/%7Btoken%7D'Try it
It needs a customer's manage token.
Example answer
{ "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, requiredThe location's short name, the last part of its booking page address.
tokenstringpath, requiredThe manage token, the last part of manageUrl.
Request body
startsAtstringrequiredstaffstring or nulloptionallocalestringoptional
Responses
200OKThe appointment.dataobjectFields of data
appointmentAppointment
402Payment requiredThe location is paused because the plan has ended.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
403ForbiddenToo close to the start, or a website that isn't allowed.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
404Not foundNo appointment with that token.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
409ConflictThe time has gone.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
422UnprocessablestartsAt is missing or isn't a time.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
429Too many requestsToo many tries from one network.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
500Server errorSomething went wrong on our side.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
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
{ "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, requiredThe location's short name, the last part of its booking page address.
tokenstringpath, requiredThe manage token, the last part of manageUrl.
Request body
Up to 500 characters.reasonstring or nulloptionallocalestringoptional
Responses
200OKThe appointment.dataobjectFields of data
appointmentAppointment
402Payment requiredThe location is paused because the plan has ended.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
403ForbiddenToo close to the start, or a website that isn't allowed.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
404Not foundNo appointment with that token.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
409ConflictOver or already cancelled.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
422UnprocessableThe reason is over 500 characters.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
429Too many requestsToo many tries from one network.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
500Server errorSomething went wrong on our side.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
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
{ "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, requiredThe location's short name, the last part of its booking page address.
tokenstringpath, requiredThe manage token, the last part of manageUrl.
Responses
200OKThe calendar file.text/calendar
404Not foundNo appointment with that token.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
429Too many requestsToo many tries from one network. Wait a minute.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
500Server errorSomething went wrong on our side.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
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
"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, requiredThe location's short name, the last part of its booking page address.
Request body
servicestringrequiredstaffstring or nulloptionalfromstringrequiredYYYY-MM-DD.
tostringrequiredYYYY-MM-DD.
Up to 120 characters.namestringrequiredemailstringrequiredphonestring or nulloptionallocalestringoptionaltimeZonestringoptional
Responses
201CreatedJoined.dataobjectFields of data
joinedtrue
402Payment requiredThe location is paused because the plan has ended.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 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.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
404Not foundThe location doesn't exist.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
422UnprocessableA field is missing or wrong.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
429Too many requestsToo many tries from one network.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
500Server errorSomething went wrong on our side.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
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
{ "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, requiredThe location's short name, the last part of its booking page address.
tokenstringpath, requiredThe token from the offer email.
Responses
200OKThe offer.dataobjectFields of data
offerOffer
402Payment requiredThe location is paused because the plan has ended.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
403ForbiddenA change from a website that isn't allowed.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
404Not foundThe offer has run out or was taken.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
429Too many requestsToo many tries from one network.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
500Server errorSomething went wrong on our side.errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
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
{ "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
errorobjectFields of error
codestringinvalid, subscription_inactive, forbidden, not_found, conflict, payment_required, rate_limited, server_error or unavailable.
messagestringIn English, fine to show to a customer.
rulestringsometimesWith payment_required: deposit, full or card-on-file.
bookingUrlstringsometimesWith 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[]sometimesOn 422: the fields that failed, each with its path and message.
Location
idstringslugstringSuch as northwilds-oslo.
namestringdescriptionstringintrostringIn the language asked for.
One of place, online.kindstringaddressobject or nullFields of address
linesstring[]citystringregionstringpostcodestringcountrystring
timeZonestringSuch as Europe/Oslo.
currencystringlocalesstring[]defaultLocalestringlogoUrlstring or nullcoverUrlstring or nullcolourstring or nullphonestring or nullemailstring or nullopeningHoursobject[]One entry per open weekday, in the location's time zone.
Fields of openingHours
dayinteger0 for Sunday to 6 for Saturday.
At least 0. At most 6.rangesobject[]Fields of ranges
fromstringSuch as 09:00.
tostringSuch as 17:00.
policiesobjectFields of policies
cancelUntilHoursintegerCustomers may cancel online until this many hours before.
rescheduleUntilHoursintegerCustomers may move online until this many hours before.
requireApprovalbooleanNew bookings wait for the team to confirm them.
bookingPageobjectHow to build the booking form.
Fields of bookingPage
showStaffbooleanCustomers may choose a person. If false, staff is empty.
showPricesbooleanIf false, every price is { kind: hidden, amount: null }.
One of required, optional, hidden.phonestring
One of required, optional, hidden.notesstringwaitlistbooleanmarketingbooleanAsk whether the customer wants news; send the answer as marketing.
termsUrlstring or nullprivacyUrlstring or null
Service
idstringslugstringSuch as boot-fitting.
namestringdescriptionstringcategorystring or nullimageUrlstring or nulldurationMinutesinteger
One of in-person, online, either.modestringpriceobjectFields of price
One of free, fixed, from, hidden.kindstringamountinteger or nullThe price. In the currency's smallest unit, so 45000 with NOK is NOK 450.
paymentobjectFields of payment
One of none, deposit, full.rulestringdepositAmountinteger or nullThe deposit. In the currency's smallest unit, so 45000 with NOK is NOK 450.
capacityintegerPlaces in one session. Above 1, several customers book the same time.
staffIdsstring[]The people who take it. Empty means anyone.
formIdstring or null
Staff
idstringnamestringtitlestring or nullbiostringphotoUrlstring or null
Question
idstringThe key in answers.
One of short-text, long-text, number, choice, choices, yes-no, date, consent, file.typestringlabelstringhelpstringrequiredbooleanoptionsobject[]Fields of options
idstringlabelstring
Slots
timeZonestringfromstringThe first day, YYYY-MM-DD.
tostringThe day after the last one.
daysobject[]Every day, with an empty slots when nothing is free.
Fields of days
datestringslotsobject[]Fields of slots
startsAtstringendsAtstringstaffIdsstring[]The people free then.
placesLeftinteger or nullFree places, for services with more than one.
nextobject or nullThe first free time, looked for beyond your days too.
Fields of next
startsAtstringstaffIdsstring[]
maxDaysintegerThe most days one call can ask for.
Appointment
referencestringSuch as 29BMJM.
One of pending, confirmed, checked-in, completed, cancelled, no-show.statusstringserviceobjectFields of service
idstringslugstringnamestringdurationMinutesinteger
One of in-person, online, either.modestring
staffstring or nullstartsAtstringendsAtstringtimeZonestringattendeeobject or nullFields of attendee
namestringemailstring or null
manageUrlstringThe customer's own page for it. Its last part is the manage token: anyone with it can move or cancel the appointment.
calendarobjectFields of calendar
icsstringA path on the Booking Orbit address.
googlestringoutlookstring
canChangebooleanWhether the customer may still move or cancel it online.
changeUntilstring or nullcancelReasonstring or nullmeetingUrlstring or nullThe video link for an online appointment, once there is one.
locationobjectFields of location
namestringslugstringaddressstring or nullonlinebooleanphonestring or nullemailstring or null
Payment
requiredbooleanTrue 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.
One of none, at-location, online.methodstring
One of deposit, full, card-on-file.rulestring or nullamountinteger or nullWhat is due. In the currency's smallest unit, so 45000 with NOK is NOK 450.
currencystringmanageTokenstring or nullurlstring or null
Offer
tokenstringSend as holdToken to book it.
serviceobjectFields of service
idstringslugstringnamestringdurationMinutesinteger
staffIdstring or nullstaffstring or nullstartsAtstringexpiresAtstringcustomerobject or nullFields of customer
namestringemailstring or nullphonestring or null
BookingInput
servicestringId or short name.
staffstring or nullsometimesstartsAtstringholdTokenstring or nullsometimesRecommended. Booking fails with 409 if the hold has run out or is for another time.
Up to 120 characters.namestringemailstringThe confirmation and reminders go here.
Up to 200 characters.phonestring or nullsometimesRequired when bookingPage.phone is required.
Up to 40 characters.
Up to 2000 characters.notesstring or nullsometimesanswersmap of anysometimesBy question id: option ids for choice and choices, true or false for yes-no and consent, YYYY-MM-DD for date.
marketingbooleansometimeslocalestringsometimesFor the customer's emails.
timeZonestringsometimesFor the customer's emails.