Developers · Reference
Admin API
Run the venue from your own systems with an API key: every operation of the admin screens and the assistant.
All paths are relative to https://{venue}.bookare.app/api/v1. Answers are { "data": … }; errors are described in Errors, dates, languages and limits. The same reference is available as OpenAPI.
Venue
GET/admin/venue
The venue: details, plan, booking rules, counts · Auth: API key · get_venue
Name, type, contact details, booking rules, payment methods and today’s numbers for the connected venue. Call this first.
Available for every venue.
PATCH/admin/venue
Change name, address, phones, email, website, opening hours · Auth: API key · update_venue
Changes the venue’s name, legal name, address, phones, contact email, website or opening hours: what customers see at the bottom of every page and in emails. Only the fields you send change; send an empty value to clear one. The venue type, country and booking address cannot be changed here.
Available for every venue.
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
name | body | string | Venue name (2-80 characters). | |
legal_name | body | string | The business’s legal name, shown on the privacy page as the data controller. | |
street | body | string | Street and number, e.g. "Agias Lavras 5-7". | |
city | body | string | City or area, e.g. "Zografou". | |
postal_code | body | string | Postal code, e.g. "157 73". | |
phones | body | array of string | Up to two phone numbers, the main one first. Numbers without a country code are taken as the venue’s country. | |
email | body | string | Contact email shown to customers. | |
website | body | string | The venue’s own website, full address like https://example.gr. Used for the “back to site” button. | |
opening_hours | body | array of string | Opening hours, one line per group of days (up to 7 lines), e.g. ["Mon–Wed 09:00–13:00 & 16:00–21:00", "Sat 09:00–14:00"]. Empty list clears them. |
PUT/admin/venue/branding
Set the logo (from a link) and colours · Auth: API key · set_branding
Sets the venue logo from a public https link to a PNG, JPG or WebP file (up to 300 KB), and/or its three colours as #rrggbb: hot (buttons, highlights), fresh (light accent), sun (yellow accent). Colours need the Plus or Pro plan (included in the trial).
Available for every venue.
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
logo_url | body | string | ||
hot | body | string | ||
fresh | body | string | ||
sun | body | string |
GET/admin/embed-code
Widget, button and link to put booking on a website · Auth: API key · get_embed_code
Copy-paste code to show this venue’s timetable, packs, services, tables or stays on any website (WordPress, Wix, Squarespace, Webflow, plain HTML), plus a "Book online" button and the booking page link.
Available for every venue.
GET/admin/dns-instructions
How to use an own domain for the booking pages · Auth: API key · get_dns_instructions
How the venue can use its own address (e.g. book.yourgym.com) for its booking pages. Available on the Pro plan; the owner switches it on in Settings → Link and domain after adding the DNS record.
Available for every venue.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
domain | query | string | Optional, e.g. book.yourgym.com. |
POST/admin/claim-link
New claim link for the owner (draft venues only) · Auth: API key · get_claim_link
A new link for the owner to claim this draft venue (the previous link stops working). The owner opens it, confirms with a code sent to their email and accepts the terms; then the booking pages open to customers. Until then the venue takes no members or bookings and sends no emails, and it is deleted automatically on its expiry date.
Available for draft venues made by an AI agent.
Needs a key with read-and-change access.
Setup
GET/admin/templates
Ready-made setups for this kind of venue · Auth: API key · list_templates
Typical setups for this kind of venue (classes and timetable and packs, or services, or tables and hours, or units). Apply one with setup_from_template, then adjust anything with the other tools.
Available for every venue.
POST/admin/templates/{template_id}/apply
Set the venue up from a template in one call · Auth: API key · setup_from_template
Fills an empty or new venue with a typical setup in one call: e.g. "pilates" adds class types, a weekly timetable, packs with prices and booking rules. Prices are suggestions: adjust them afterwards (update_pack, add_service…). replace_starter = true removes the empty starter class type made at sign-up.
Available for every venue.
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
template_id | path | string | yes | |
replace_starter | body | boolean | Default true. |
Classes
GET/admin/class-types
Kinds of class · Auth: API key · list_class_types
The kinds of class the venue runs (e.g. Pilates Reformer, Fitness), with default spots.
Available for venues with classes (gyms and studios).
POST/admin/class-types
Add a kind of class · Auth: API key · create_class_type
Adds a kind of class (e.g. "Yoga Flow") that can then be put on the weekly timetable.
Available for venues with classes (gyms and studios).
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
name | body | string | yes | |
spots | body | integer | yes | Default spots per class (1-50). |
colour | body | fresh | hot | sun | ink | chip | fresh = light green, hot = red, sun = yellow, ink = dark, chip = grey. | |
booked_with_packs | body | boolean | Default true. False = only the venue books it, no pack is charged. | |
drop_in | body | boolean | True = no times on the timetable: people just come in and check in (e.g. the gym floor). Each check-in takes one class from their pack, at most once a day. |
PATCH/admin/class-types/{class_type_id}
Change a kind of class · Auth: API key · update_class_type
Renames a class type or changes its default spots, colour, whether packs are charged or whether it is drop-in. Spots apply to classes created from now on.
Available for venues with classes (gyms and studios).
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
class_type_id | path | string | yes | |
name | body | string | ||
spots | body | integer | ||
colour | body | fresh | hot | sun | ink | chip | ||
booked_with_packs | body | boolean | ||
drop_in | body | boolean | True = no times on the timetable: people just come in and check in (e.g. the gym floor). Each check-in takes one class from their pack, at most once a day. |
DELETE/admin/class-types/{class_type_id}
Delete a kind of class that was never used · Auth: API key · delete_class_type
Deletes a class type that has never been on the timetable. One that has classes or history cannot be deleted; rename it instead.
Available for venues with classes (gyms and studios).
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
class_type_id | path | string | yes |
GET/admin/instructors
Instructors · Auth: API key · list_instructors
Instructors that can be put on a class.
Available for venues with classes (gyms and studios).
POST/admin/instructors
Add an instructor · Auth: API key · add_instructor
Adds a name to the instructors that can be put on a class.
Available for venues with classes (gyms and studios).
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
name | body | string | yes |
Timetable
GET/admin/timetable
The weekly timetable · Auth: API key · get_timetable
The repeating weekly timetable: one row per weekly class. Classes on the calendar are generated from these.
Available for venues with classes (gyms and studios).
POST/admin/timetable
Add a weekly class · Auth: API key · add_weekly_class
Adds a repeating class to the weekly timetable. Classes for the coming days appear on the calendar at once.
Available for venues with classes (gyms and studios).
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
weekday | body | integer | yes | 0 = Monday … 6 = Sunday. |
time | body | string | yes | Start time in the venue’s local time, HH:MM (24h). |
class_type_id | body | string | yes | |
instructor_id | body | string | Optional. From list_instructors. | |
spots | body | integer | Optional. Defaults to the class type’s spots (1-50). | |
duration_minutes | body | integer | Optional, default 60 (15-240). | |
off_peak | body | boolean | Optional. Marks the class as off-peak. |
PATCH/admin/timetable/{weekly_class_id}
Change a weekly class (from a date on) · Auth: API key · update_weekly_class
Moves a weekly class to another day or time, or changes its type, instructor, spots, duration or off-peak mark. Only the fields you send change. Dates that already have bookings stay at the old time.
Available for venues with classes (gyms and studios).
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
weekly_class_id | path | string | yes | |
weekday | body | integer | 0 = Monday … 6 = Sunday. | |
time | body | string | Start time in the venue’s local time, HH:MM (24h). | |
class_type_id | body | string | ||
instructor_id | body | string | Optional. From list_instructors. | |
spots | body | integer | Optional. Defaults to the class type’s spots (1-50). | |
duration_minutes | body | integer | Optional, default 60 (15-240). | |
off_peak | body | boolean | Optional. Marks the class as off-peak. |
DELETE/admin/timetable/{weekly_class_id}
Remove a weekly class · Auth: API key · remove_weekly_class
Takes a class off the weekly timetable. Future dates without bookings disappear; dates that already have bookings stay.
Available for venues with classes (gyms and studios).
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
weekly_class_id | path | string | yes |
PUT/admin/booking-rules
Cancellation window, days ahead, bookings before payment · Auth: API key · set_booking_rules
Sets how many hours before a class a member can cancel free, how many classes can be booked on an unpaid pack, and how many days ahead members can book. Only the fields you send change.
Available for venues with classes (gyms and studios).
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
free_cancellation_hours_before | body | integer | 0-168 | |
bookings_allowed_on_unpaid_pack | body | integer | 0-50 | |
days_ahead_members_can_book | body | integer | 1-60 |
Bookings
GET/admin/classes
Classes on the calendar between two dates, with how full they are · Auth: API key · list_classes
Actual classes between two dates (at most 31 days), with how many spots are taken. Defaults to today and the next 7 days.
Available for venues with classes (gyms and studios).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
from | query | string | First day, YYYY-MM-DD. Default: today. | |
to | query | string | Last day, YYYY-MM-DD. Default: from + 7 days. |
GET/admin/classes/{class_id}
One class with its bookings · Auth: API key · get_class
A single class with everyone booked on it (members and guests) and their attendance.
Available for venues with classes (gyms and studios).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
class_id | path | string | yes |
POST/admin/classes/{class_id}/bookings
Book a member or a guest into a class · Auth: API key · book_class
Books a member (one class is taken from their pack) or a guest by name on a class. free = true books a member without charging a pack (a gift).
Available for venues with classes (gyms and studios).
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
class_id | path | string | yes | |
member_id | body | string | ||
guest_name | body | string | For a person without an account. Leave out member_id. | |
free | body | boolean |
DELETE/admin/bookings/{booking_id}
Cancel a booking (the class goes back to the pack) · Auth: API key · cancel_booking
Cancels one booking. When the venue cancels, the class always goes back to the member’s pack.
Available for venues with classes (gyms and studios).
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
booking_id | path | string | yes |
PUT/admin/bookings/{booking_id}/attendance
Mark attended, no-show or booked · Auth: API key · set_attendance
Marks a booking as attended or no_show, or puts it back to booked.
Available for venues with classes (gyms and studios).
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
booking_id | path | string | yes | |
status | body | attended | no_show | booked | yes |
Members
GET/admin/members
Members (search, filter by status, 50 per page) · Auth: API key · list_members
Members of the venue. Search by part of a name, email or phone; filter by status. Returns at most 50 per call. Health answers are never included.
Available for venues with classes (gyms and studios).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
search | query | string | Part of a name, email or phone. | |
status | query | active | pending | disabled | rejected | pending = signed up, waiting for approval. | |
offset | query | integer | Skip this many, for the next page. |
POST/admin/members
Add a member · Auth: API key · create_member
Adds a member with name and email or phone. Use only for a person who asked the venue to register them. No health details can be stored this way. The plan’s member limit applies.
Available for venues with classes (gyms and studios).
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
name | body | string | yes | Full name. |
email | body | string | ||
phone | body | string | ||
address | body | string | ||
activate | body | boolean | True = can buy packs and book at once. Default false (waits for approval). |
GET/admin/members/{member_id}
A member with packs, bookings and history · Auth: API key · get_member
A member’s details, groups, packs, upcoming bookings and recent history. Health answers are not available through this connection.
Available for venues with classes (gyms and studios).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
member_id | path | string | yes |
PATCH/admin/members/{member_id}
Change a member’s details · Auth: API key · update_member
Changes a member’s name, phone or address. The email cannot be changed through this connection (whoever controls the email controls the account); do that on the member’s page.
Available for venues with classes (gyms and studios).
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
member_id | path | string | yes | |
name | body | string | ||
phone | body | string | ||
address | body | string |
PUT/admin/members/{member_id}/status
Approve, deactivate or reject a member · Auth: API key · set_member_status
active = approve a waiting sign-up or re-enable an account (a newly approved member gets an email). disabled = the member can no longer sign in or book; nothing is deleted.
Available for venues with classes (gyms and studios).
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
member_id | path | string | yes | |
status | body | active | disabled | yes |
POST/admin/members/{member_id}/packs
Give a member a pack · Auth: API key · give_pack
Adds a pack on sale to a member’s account, as if they took it at the desk. Set paid to true only if the money was actually received.
Available for venues with classes (gyms and studios).
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
member_id | path | string | yes | |
pack_id | body | string | yes | From list_packs. |
paid | body | boolean | Default false (shows as unpaid). | |
method | body | cash | iris | How it is or will be paid. Default cash (at the store). |
PUT/admin/member-packs/{member_pack_id}/paid
Mark a member’s pack paid or unpaid · Auth: API key · set_pack_paid
Records that a member’s pack was paid (and how), or puts it back to unpaid. Use only when the owner says the money was received.
Available for venues with classes (gyms and studios).
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
member_pack_id | path | string | yes | |
paid | body | boolean | yes | |
method | body | cash | card | iris | Needed when paid is true. |
PUT/admin/member-packs/{member_pack_id}/pay-later
Let a member book before paying, until a date · Auth: API key · allow_booking_before_payment
For an unpaid member pack ("I will pay in a few days"): how many classes the member can book before paying, and until when. classes = a number, or all = true for all classes. Leave both out (or reset = true) to go back to the venue’s general rule. After the until date the general rule applies again.
Available for venues with classes (gyms and studios).
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
member_pack_id | path | string | yes | |
classes | body | integer | Up to this many classes before payment (0-200). | |
all | body | boolean | True: all the classes of the pack. | |
until | body | string | Optional last day, YYYY-MM-DD (usually the day they said they would pay). | |
reset | body | boolean | True: back to the general rule. |
GET/admin/unpaid
Unpaid member packs · Auth: API key · list_unpaid
Packs members have taken but not paid for yet, oldest first.
Available for venues with classes (gyms and studios).
Packs
GET/admin/packs
Packs on sale · Auth: API key · list_packs
The packs the venue sells (including hidden ones), in the order members see them.
Available for venues with classes (gyms and studios).
POST/admin/packs
Create a pack · Auth: API key · create_pack
Adds a new pack to what the venue sells. It is visible to members straight away unless you hide it with set_pack_visibility.
Available for venues with classes (gyms and studios).
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
name | body | string | yes | Name shown to members, e.g. "Move 10". |
classes | body | integer | How many classes the pack holds (1-200). Leave out when unlimited is true. | |
unlimited | body | boolean | True for unlimited classes until it expires. | |
valid_days | body | integer | yes | Days the pack is valid from the day it is bought (1-730). |
price_eur | body | number | yes | Price in euro, e.g. 59.9. |
tagline | body | string | One short line under the name. | |
description | body | string | Longer description shown with the pack. | |
class_type_ids | body | array of string | Class types the pack can be used for. Empty list = all. | |
off_peak_only | body | boolean | True if it can be used only for classes marked off-peak. | |
on_sale_until | body | string | YYYY-MM-DD: a limited-time pack members can buy until the end of that day. Empty string = always on sale. |
PATCH/admin/packs/{pack_id}
Change a pack · Auth: API key · update_pack
Changes a pack on sale. Only the fields you send change. Packs members have already bought keep their own terms and are not affected.
Available for venues with classes (gyms and studios).
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
pack_id | path | string | yes | |
name | body | string | Name shown to members, e.g. "Move 10". | |
classes | body | integer | How many classes the pack holds (1-200). Leave out when unlimited is true. | |
unlimited | body | boolean | True for unlimited classes until it expires. | |
valid_days | body | integer | Days the pack is valid from the day it is bought (1-730). | |
price_eur | body | number | Price in euro, e.g. 59.9. | |
tagline | body | string | One short line under the name. | |
description | body | string | Longer description shown with the pack. | |
class_type_ids | body | array of string | Class types the pack can be used for. Empty list = all. | |
off_peak_only | body | boolean | True if it can be used only for classes marked off-peak. | |
on_sale_until | body | string | YYYY-MM-DD: a limited-time pack members can buy until the end of that day. Empty string = always on sale. |
DELETE/admin/packs/{pack_id}
Delete a pack · Auth: API key · delete_pack
Permanently removes a pack from what the venue sells. Packs members already bought are kept. Prefer set_pack_visibility unless the owner clearly asked to delete.
Available for venues with classes (gyms and studios).
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
pack_id | path | string | yes |
PUT/admin/packs/{pack_id}/visibility
Activate or deactivate a pack · Auth: API key · set_pack_visibility
visible = false deactivates a pack: it is hidden and can no longer be bought; members who have it keep it. visible = true activates it again. This is the safe way to stop selling a pack.
Available for venues with classes (gyms and studios).
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
pack_id | path | string | yes | |
visible | body | boolean | yes |
Coupons
GET/admin/coupons
Coupons · Auth: API key · list_coupons
Coupons for buying packs: automatic ones and ones with a code, with who and which packs they are for, dates and how often they were used.
Available for venues with classes (gyms and studios).
POST/admin/coupons
Create a coupon · Auth: API key · create_coupon
Creates a coupon for buying packs. kind: percent (value = % off), amount (value_eur off), extra (value = free classes added), bonus (value = % more classes, same price and expiry: 30 turns 10 classes into 13; 100 = 1+1, double). Free classes do not apply to unlimited packs. Without code it applies automatically to the members it is for; with code the member types it when buying.
Available for venues with classes (gyms and studios).
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
name | body | string | yes | Shown to members next to the price, e.g. "New Year". |
kind | body | percent | amount | extra | bonus | yes | |
value | body | integer | percent: 1-100; extra: 1-100 classes; bonus: 1-500 (% more classes, 100 = 1+1). Not for amount. | |
value_eur | body | number | Only for kind amount, e.g. 10. | |
code | body | string | Optional code, 3-30 Latin letters, digits or dashes. Leave out for an automatic coupon. | |
from | body | string | Optional first day, YYYY-MM-DD. | |
until | body | string | Optional last day, YYYY-MM-DD. | |
member_ids | body | array of string | Only for these members (with group_ids). Leave both out for all members. | |
group_ids | body | array of string | ||
pack_ids | body | array of string | Only for these packs (from list_packs). Leave out for all packs. | |
max_uses | body | integer | Total uses. Leave out for no limit. | |
per_member | body | integer | Uses per member, 0 = no limit. Default 1. |
PUT/admin/coupons/{coupon_id}/active
Pause or resume a coupon · Auth: API key · set_coupon_active
Pauses a coupon (it stops applying) or resumes it. Packs already bought with it are not affected.
Available for venues with classes (gyms and studios).
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
coupon_id | path | string | yes | |
active | body | boolean | yes |
Sales
GET/admin/sales
Pack sales between two dates · Auth: API key · get_sales
Packs paid between two dates (at most 366 days): total, by payment method and by pack. Defaults to this month so far.
Available for venues with classes (gyms and studios).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
from | query | string | YYYY-MM-DD. Default: first day of this month. | |
to | query | string | YYYY-MM-DD. Default: today. |
Import
GET/admin/import
What has been brought over so far · Auth: API key · import_status
For moving a venue from another system. Shows how many members, packs, bookings and check-ins were imported (and how many exist in total). Order of a move: first set up class types, instructors, packs on sale and the weekly timetable with the usual tools; then import_members, import_member_packs, import_bookings and import_visits, in that order, up to 100 rows per call. Nothing is emailed to anyone, and re-running with the same external_id values does not create duplicates.
Available for venues with classes (gyms and studios).
POST/admin/import/members
Bring over members (up to 100 per call) · Auth: API key · import_members
Moving from another system: adds up to 100 existing or former members at once, with their join date and status. No email is sent. A row whose external_id was imported before, or whose email already exists here, is reported as existing and left as it is (use update_member to change it). Needs email, phone or external_id per row. Members who joined in the last 90 days count towards the plan’s member limit.
Available for venues with classes (gyms and studios).
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
members | body | array of object | yes | Up to 100 rows. |
POST/admin/import/packs
Bring over members’ packs · Auth: API key · import_member_packs
Moving from another system: adds up to 100 member packs at once, current or past, with their start and expiry dates, classes already used, price and whether (and when) they were paid. No email is sent and no receipt is asked for. Import members first. Bookings imported later do not take classes again: classes_used is what counts.
Available for venues with classes (gyms and studios).
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
packs | body | array of object | yes | Up to 100 rows. |
POST/admin/import/bookings
Bring over bookings and attendance history · Auth: API key · import_bookings
Moving from another system: adds up to 100 bookings at once, past (with attendance) or upcoming. Each row names the class by class_id, or by date, time and class_type_id; a past class that is not on the calendar is created. An upcoming class must already be on the calendar (add the weekly timetable first). Nothing is emailed and no pack is charged again (classes_used on the imported pack already counts them); the booking is linked to the member’s pack so a later cancellation gives the class back.
Available for venues with classes (gyms and studios).
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
bookings | body | array of object | yes | Up to 100 rows. |
POST/admin/import/visits
Bring over drop-in check-ins · Auth: API key · import_visits
Moving from another system: adds up to 100 past check-ins at once for drop-in class types (no times on the timetable, people just come in), one per member, class type and day. No pack is charged again; the visit is linked to the given pack, or the member’s pack that covered that day.
Available for venues with classes (gyms and studios).
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
visits | body | array of object | yes | Up to 100 rows. |
Appointments and tables
GET/admin/agenda
Services, staff or tables, and opening hours · Auth: API key · get_agenda_setup
What the venue offers by appointment (services with duration and price, staff) or, for restaurants, its tables; and the opening hours.
Available for venues with appointments or tables.
POST/admin/services
Add a service · Auth: API key · add_service
Adds a service customers can book by appointment, e.g. "Women’s haircut", 45 minutes, €25. It is done by the staff listed (default: all staff). Not for restaurants.
Available for venues with appointments or tables.
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
name | body | string | yes | |
minutes | body | integer | yes | 5-480. |
price_eur | body | number | Leave out for "price on request". | |
description | body | string | ||
staff_ids | body | array of string | Default: all staff. |
POST/admin/staff
Add a staff member · Auth: API key · add_staff
Adds a person customers can book with. They do all services unless service_ids is given. Not for restaurants.
Available for venues with appointments or tables.
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
name | body | string | yes | First name is enough, e.g. "Maria". |
service_ids | body | array of string |
POST/admin/tables
Add tables · Auth: API key · add_table
Restaurants and bars: adds a table (or several identical ones) with its seats. Online bookings get the smallest free table that fits the party.
Available for venues with appointments or tables.
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
name | body | string | yes | e.g. "Table" or "Terrace". Numbered automatically when count > 1. |
seats | body | integer | yes | 1-30. |
count | body | integer | How many identical tables, default 1 (max 40). | |
from_party_of | body | integer | Smallest party it is given to online, default 1. |
PUT/admin/opening-hours
Replace the hours that can be booked · Auth: API key · set_opening_hours
Replaces the hours when appointments or tables can be booked. One row per period, several per day allowed (e.g. 10:00-14:00 and 17:00-21:00). Days not listed are closed. For restaurants "to" is the last time a table can be booked.
Available for venues with appointments or tables.
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
hours | body | array of object | yes |
Stays
GET/admin/stay-options
Allowed unit kinds, beds and amenities · Auth: API key · list_stay_options
The fixed lists used by the other tools: unit kinds, bed kinds, amenity keys for units and for the venue (with their English and Greek labels).
Available for stays venues.
GET/admin/units
Units (rooms, homes, pitches…) · Auth: API key · list_units
Everything the venue rents by the night (rooms, homes, caravans, pitches) with price, capacity, beds, amenities and photos. Includes hidden units.
Available for stays venues.
POST/admin/units
Add a unit · Auth: API key · create_unit
Adds something the venue rents by the night: a room, apartment, home, caravan, glamping tent or pitch. For several identical ones (e.g. 20 pitches) create one unit and set identical_units. Guests can see and book it straight away unless shown_to_guests or takes_bookings is false.
Available for stays venues.
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
name | body | string | yes | Name guests see, e.g. "Sea-view studio" or "Tent or camper pitch". |
kind | body | room | apartment | home | caravan | glamping | pitch | other | yes | What it is. |
price_per_night_eur | body | number | yes | Base price per night in euro (seasons can override it). |
guests_up_to | body | integer | Most guests it takes (1-60). | |
identical_units | body | integer | How many identical ones exist, e.g. 20 tent and camper pitches. Default 1. | |
min_nights | body | integer | Minimum nights per booking. Default 1. | |
description | body | string | Free text for guests (up to 600 characters). | |
bedrooms | body | integer | 0 = not shown. | |
bathrooms | body | integer | 0 = not shown. | |
size_sqm | body | integer | Size in square metres. 0 = not shown. | |
beds | body | object | How many beds of each kind, e.g. {"double":1,"single":2}. Kinds: double, single, sofa, bunk. | |
amenities | body | array of string | Amenity keys from list_stay_options (unit_amenities), e.g. ["wifi","ac","kitchen"]. | |
shown_to_guests | body | boolean | False hides the unit from the booking page. Default true. | |
takes_bookings | body | boolean | False keeps the unit visible to guests but they cannot book it (e.g. not ready yet); its nights are closed on connected channels too. The venue can still add bookings itself. Default true. |
PATCH/admin/units/{unit_id}
Change a unit · Auth: API key · update_unit
Changes a unit. Only the fields you send change. Existing bookings keep their agreed total.
Available for stays venues.
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
unit_id | path | string | yes | |
name | body | string | Name guests see, e.g. "Sea-view studio" or "Tent or camper pitch". | |
kind | body | room | apartment | home | caravan | glamping | pitch | other | What it is. | |
price_per_night_eur | body | number | Base price per night in euro (seasons can override it). | |
guests_up_to | body | integer | Most guests it takes (1-60). | |
identical_units | body | integer | How many identical ones exist, e.g. 20 tent and camper pitches. Default 1. | |
min_nights | body | integer | Minimum nights per booking. Default 1. | |
description | body | string | Free text for guests (up to 600 characters). | |
bedrooms | body | integer | 0 = not shown. | |
bathrooms | body | integer | 0 = not shown. | |
size_sqm | body | integer | Size in square metres. 0 = not shown. | |
beds | body | object | How many beds of each kind, e.g. {"double":1,"single":2}. Kinds: double, single, sofa, bunk. | |
amenities | body | array of string | Amenity keys from list_stay_options (unit_amenities), e.g. ["wifi","ac","kitchen"]. | |
shown_to_guests | body | boolean | False hides the unit from the booking page. Default true. | |
takes_bookings | body | boolean | False keeps the unit visible to guests but they cannot book it (e.g. not ready yet); its nights are closed on connected channels too. The venue can still add bookings itself. Default true. |
DELETE/admin/units/{unit_id}
Delete a unit · Auth: API key · delete_unit
Deletes a unit together with its photos. A unit that has ever had a booking is not deleted: it is hidden from guests instead, so the booking history stays.
Available for stays venues.
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
unit_id | path | string | yes |
GET/admin/units/{unit_id}/calendar
A unit night by night: price, closed, booked · Auth: API key · get_unit_calendar
Night by night for one unit (at most 92 nights), like the calendar in the admin: the price guests pay, whether it is the night’s own price, whether the venue closed it (and why), how many of the identical units are taken and free. Also the bookings and other-channel blocks touching those nights. Defaults to today and the next 30 nights.
Available for stays venues.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
unit_id | path | string | yes | |
from | query | string | First night, YYYY-MM-DD. Default: today. | |
nights | query | integer | 1-92. Default 30. |
GET/admin/listing
The public listing: text, amenities, photos · Auth: API key · get_listing
What a guest sees at the top of the booking page: the description of the place, its amenities and its photos. Also the booking rules and the seasonal prices.
Available for stays venues.
PUT/admin/listing
Change the listing text and amenities · Auth: API key · set_listing
Sets the description of the place shown at the top of the booking page, and the venue-wide amenities. Send only what should change.
Available for stays venues.
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
about | body | string | Up to 1500 characters. | |
amenities | body | array of string | Keys from list_stay_options (venue_amenities). Replaces the current list. |
POST/admin/photos
Add a photo from a public link · Auth: API key · add_photo
Adds a photo to a unit, or to the venue itself when unit_id is left out. Give the direct public https link to an existing photo file (jpg, png or webp, up to 15 MB): it is downloaded, resized and stored. The first photo of a group is its cover. Up to 16 per unit and for the venue. Use only photos the venue owns or may use; this tool cannot create images.
Available for stays venues.
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
image_url | body | string | yes | Direct link to the photo file. |
unit_id | body | string | Leave out for a photo of the venue as a whole. | |
make_cover | body | boolean | True puts it first. |
DELETE/admin/photos/{photo_id}
Remove a photo · Auth: API key · remove_photo
Deletes one photo (of a unit or of the venue) for good.
Available for stays venues.
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
photo_id | path | string | yes |
PUT/admin/photos/{photo_id}/cover
Make a photo the cover · Auth: API key · set_cover_photo
Puts a photo first in its group (the unit or the venue), so it is the one guests see in lists.
Available for stays venues.
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
photo_id | path | string | yes |
GET/admin/availability
Free units and prices for dates · Auth: API key · check_availability
For a check-in and check-out date and a number of guests: which units are free, how many are left and the total price. closed_by_venue is true when a night falls on a day the venue closed; takes_bookings false means guests cannot book that unit online.
Available for stays venues.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
check_in | query | string | yes | YYYY-MM-DD |
check_out | query | string | yes | YYYY-MM-DD (the day the guest leaves) |
guests | query | integer | Default 2. |
GET/admin/stay-bookings
Stay bookings between two dates · Auth: API key · list_stay_bookings
Bookings that hold a unit (requested, confirmed, in house) and touch a date range of at most 62 days. Defaults to today and the next 30 days. Guest name and booking code only; contact details are not available here.
Available for stays venues.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
from | query | string | First day, YYYY-MM-DD. Default: today. | |
to | query | string | Last day, YYYY-MM-DD. Default: from + 30 days. |
GET/admin/closed-days
Closed nights · Auth: API key · list_closed_days
Days the venue has closed itself (holiday, own use, an event), for one unit or for all units. Nobody can book those nights, online, by the venue or on connected channels. Defaults to everything from today on.
Available for stays venues.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
from | query | string | YYYY-MM-DD. Default: today. | |
to | query | string | YYYY-MM-DD. Default: no end. |
POST/admin/closed-days
Close nights (one unit or all) · Auth: API key · close_days
Makes one day or a whole range unavailable, for one unit or (without unit_id) for all units: no bookings can be made on those nights, online, by the venue or on connected channels. A closed day means nobody can stay that night. Existing bookings on those days are not cancelled; they are listed in the answer. For one day, send only from.
Available for stays venues.
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
from | body | string | yes | First closed night, YYYY-MM-DD. |
to | body | string | Last closed night (inclusive), YYYY-MM-DD. Default: same as from. | |
unit_id | body | string | Leave out to close all units. | |
reason | body | string | Optional, only the venue sees it, e.g. "Holiday" or "Family visit". |
POST/admin/closed-days/open
Open closed nights again · Auth: API key · open_days
Opens closed days again for bookings. With unit_id it opens only what was closed for that unit (days closed for all units stay closed); without unit_id it opens every closed day in the range. Part of a longer closed range can be opened; the rest stays closed.
Available for stays venues.
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
from | body | string | yes | First night to open, YYYY-MM-DD. |
to | body | string | Last night to open (inclusive), YYYY-MM-DD. Default: same as from. | |
unit_id | body | string | Leave out to open the range for all units. |
GET/admin/nightly-prices
Own prices for specific nights · Auth: API key · list_nightly_prices
Every night that has its own price (set with set_nightly_price), joined into ranges with the same price. For one unit or all. Defaults to today and the next 365 days. Seasons are in get_listing.
Available for stays venues.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
unit_id | query | string | Leave out for all units. | |
from | query | string | YYYY-MM-DD. Default: today. | |
to | query | string | YYYY-MM-DD, inclusive. Default: from + 365 days. |
PUT/admin/nightly-prices
Set a price for specific nights · Auth: API key · set_nightly_price
Gives its own price per night to one night or a range (e.g. Christmas), for one unit or (without unit_id) for every unit. It wins over seasons and the base price. weekdays limits it to some days of the week, e.g. ["fri","sat"] for weekends in July. Existing bookings keep their agreed total. For one night, send only from.
Available for stays venues.
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
unit_id | body | string | Leave out to set it on every unit. | |
from | body | string | yes | First night, YYYY-MM-DD. |
to | body | string | Last night (inclusive), YYYY-MM-DD. Default: same as from. | |
price_per_night_eur | body | number | yes | |
weekdays | body | array of string | Optional: only these nights of the week. |
POST/admin/nightly-prices/reset
Back to the normal price for some nights · Auth: API key · reset_nightly_price
Removes the own price of nights in a range, so they go back to the season or base price. For one unit or (without unit_id) every unit. For one night, send only from.
Available for stays venues.
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
unit_id | body | string | Leave out for every unit. | |
from | body | string | yes | YYYY-MM-DD |
to | body | string | YYYY-MM-DD, inclusive. Default: same as from. |
POST/admin/seasons
Add a season with its own price · Auth: API key · add_season
A date range with a different price per night (high season, Easter…), for one unit or for all. Nights inside it use this price instead of the unit’s base price. A season for a specific unit wins over one for all units; a night’s own price (set_nightly_price) wins over both.
Available for stays venues.
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
from | body | string | yes | First night, YYYY-MM-DD. |
to | body | string | yes | Last night (inclusive), YYYY-MM-DD. |
price_per_night_eur | body | number | yes | |
name | body | string | Optional label, e.g. "August". | |
unit_id | body | string | Leave out to apply to all units. | |
min_nights | body | integer | Optional minimum stay for bookings that start in this season (2-60). |
DELETE/admin/seasons/{season_id}
Remove a season · Auth: API key · remove_season
Deletes a seasonal price. Nights in it go back to the base price. Existing bookings keep their agreed total.
Available for stays venues.
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
season_id | path | string | yes |
PUT/admin/stay-rules
Check-in/out times, instant confirmation, cancellation · Auth: API key · set_stay_rules
Check-in and check-out times, whether online bookings are confirmed at once or wait for the venue, and until how many days before arrival a guest may cancel. Send only what should change.
Available for stays venues.
Needs a key with read-and-change access.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
check_in_from | body | string | HH:MM | |
check_out_by | body | string | HH:MM | |
instant_confirmation | body | boolean | False = each online booking waits for the venue to confirm. | |
guest_can_cancel_until_days_before | body | integer | 0-60 |