--- updatedAt: 2026-05-27T11:39:00.000Z agentTools: projectIndex: https://developers.bookingexperts.com/llms.txt --- # GET administrations Returns all administrations accessible for the current subscription # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "version": "1.0.0", "title": "Booking Experts API V3", "description": "This API is an interface for querying information from and enacting change inside a Booking Experts administration.", "contact": { "name": "Booking Experts Integrations", "url": "https://integrations.bookingexperts.nl/", "email": "integrations@bookingexperts.nl" } }, "servers": [ { "url": "https://api.bookingexperts.com", "description": "Production" }, { "url": "https://api.staging.bookingexperts.com", "description": "Staging" } ], "security": [], "tags": [ { "name": "Administrations" } ], "paths": { "/v3/administrations": { "get": { "summary": "GET administrations", "operationId": "administrations-index", "tags": [ "Administrations" ], "description": "Returns all administrations accessible for the current subscription", "parameters": [ { "name": "page[number]", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 }, "description": "Page number", "example": 1 }, { "name": "page[size]", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "Page size", "example": 10 }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Sort. Specify a comma separated list of attributes to sort on. Prefix attribute with a \\- to sort in descending order. Allowed attributes: id, created_at, updated_at", "example": "id" }, { "name": "fields[administration]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Fieldset. Specify a comma separated list of attributes to return", "example": "field1,field2" }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Includes list. Specify a comma separated list of resources to include.", "example": "relationship1,relationship2" }, { "name": "filter[id]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on ID", "example": "1" }, { "name": "filter[name]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on name", "example": "name" }, { "name": "filter[email]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on email", "example": "email" }, { "name": "filter[phone]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on phone", "example": "phone" }, { "name": "filter[website]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on website", "example": "website" }, { "name": "filter[native_currency]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on native_currency", "example": "native_currency" }, { "name": "filter[address]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on address", "example": "address" }, { "name": "filter[city]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on city. Specify a comma separated list of IDs to filter on.", "example": "1,2" }, { "name": "filter[description]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on description", "example": "description" }, { "name": "filter[surroundings_description]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on surroundings_description", "example": "surroundings_description" }, { "name": "filter[tin]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on tin", "example": "tin" }, { "name": "filter[available_locales]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on available_locales", "example": "available_locales" }, { "name": "filter[native_locale]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on native_locale", "example": "native_locale" }, { "name": "filter[timezone]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on timezone", "example": "timezone" }, { "name": "filter[invoice_email]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on invoice_email", "example": "invoice_email" }, { "name": "filter[invoice_phone]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on invoice_phone", "example": "invoice_phone" }, { "name": "filter[invoice_address]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on invoice_address", "example": "invoice_address" }, { "name": "filter[invoice_postalcode]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on invoice_postalcode", "example": "invoice_postalcode" }, { "name": "filter[invoice_city]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on invoice_city", "example": "invoice_city" }, { "name": "filter[invoice_country_code]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on invoice_country_code", "example": "invoice_country_code" }, { "name": "filter[guest_list_group]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on guest_list_group", "example": "guest_list_group" }, { "name": "filter[guest_accepted_document_type]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on guest_accepted_document_type", "example": "guest_accepted_document_type" }, { "name": "filter[guest_identification_required]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on guest_identification_required", "example": "guest_identification_required" }, { "name": "filter[ask_for_guest_gender]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on ask_for_guest_gender", "example": "ask_for_guest_gender" }, { "name": "filter[ask_for_guest_address]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on ask_for_guest_address", "example": "ask_for_guest_address" }, { "name": "filter[ask_for_guest_postal_code]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on ask_for_guest_postal_code", "example": "ask_for_guest_postal_code" }, { "name": "filter[ask_for_guest_city]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on ask_for_guest_city", "example": "ask_for_guest_city" }, { "name": "filter[ask_for_guest_country]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on ask_for_guest_country", "example": "ask_for_guest_country" }, { "name": "filter[ask_for_guest_email]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on ask_for_guest_email", "example": "ask_for_guest_email" }, { "name": "filter[ask_for_guest_phone]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on ask_for_guest_phone", "example": "ask_for_guest_phone" }, { "name": "filter[ask_for_guest_profession]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on ask_for_guest_profession", "example": "ask_for_guest_profession" }, { "name": "filter[ask_for_guest_signature]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on ask_for_guest_signature", "example": "ask_for_guest_signature" }, { "name": "filter[ask_for_fellow_guest_gender]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on ask_for_fellow_guest_gender", "example": "ask_for_fellow_guest_gender" }, { "name": "filter[ask_for_fellow_guest_address]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on ask_for_fellow_guest_address", "example": "ask_for_fellow_guest_address" }, { "name": "filter[ask_for_fellow_guest_postal_code]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on ask_for_fellow_guest_postal_code", "example": "ask_for_fellow_guest_postal_code" }, { "name": "filter[ask_for_fellow_guest_city]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on ask_for_fellow_guest_city", "example": "ask_for_fellow_guest_city" }, { "name": "filter[ask_for_fellow_guest_country]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on ask_for_fellow_guest_country", "example": "ask_for_fellow_guest_country" }, { "name": "filter[ask_for_fellow_guest_email]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on ask_for_fellow_guest_email", "example": "ask_for_fellow_guest_email" }, { "name": "filter[ask_for_fellow_guest_phone]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on ask_for_fellow_guest_phone", "example": "ask_for_fellow_guest_phone" }, { "name": "filter[ask_for_fellow_guest_profession]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on ask_for_fellow_guest_profession", "example": "ask_for_fellow_guest_profession" }, { "name": "filter[ask_for_fellow_guest_signature]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on ask_for_fellow_guest_signature", "example": "ask_for_fellow_guest_signature" }, { "name": "filter[default_option_validity]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on default_option_validity", "example": "default_option_validity" }, { "name": "filter[latitude]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on latitude", "example": "latitude" }, { "name": "filter[longitude]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on longitude", "example": "longitude" }, { "name": "filter[allow_multi_reservation_bookings_through_api]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on allow_multi_reservation_bookings_through_api", "example": "allow_multi_reservation_bookings_through_api" }, { "name": "filter[accounting_closed_upto]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on accounting_closed_upto", "example": "accounting_closed_upto" }, { "name": "filter[enable_license_plates]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on enable_license_plates", "example": "enable_license_plates" }, { "name": "filter[iban]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on iban", "example": "iban" }, { "name": "filter[bic]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on bic", "example": "bic" }, { "name": "filter[created_at]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on created_at", "example": "created_at" }, { "name": "filter[updated_at]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on updated_at", "example": "updated_at" }, { "name": "filter[checkin_timetable]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on checkin_timetable. Specify a comma separated list of IDs to filter on.", "example": "1,2" }, { "name": "filter[checkout_timetable]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on checkout_timetable. Specify a comma separated list of IDs to filter on.", "example": "1,2" }, { "name": "filter[payment_handlers]", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter on payment_handlers. Specify a comma separated list of IDs to filter on.", "example": "1,2" }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Supported languages. A comma separated list with one or more of the following locales: cs, da-DK, de, de-AT, de-CH, en-US, en-GB, es, fr, fr-BE, fr-LU, it, nb, nl, nl-BE, pl, pt, tr, en, da. Default: 'en'.", "example": "en,nl" } ], "responses": { "200": { "$ref": "#/components/responses/AdministrationCollectionResponse" }, "429": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } }, "security": [ { "ApiKeyAuth": [] }, { "OAuth2": [] } ] } } }, "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "name": "X-API-KEY", "in": "header" }, "OAuth2": { "type": "oauth2", "flows": { "authorizationCode": { "authorizationUrl": "/oauth/authorize", "tokenUrl": "/oauth/token", "refreshUrl": "/oauth/token", "scopes": { "administration|read": "Read administrations", "age_group|read": "Read age groups", "agenda_period|delete": "Delete blocked periods", "agenda_period|read": "Read blocked periods", "agenda_period|write": "Update blocked periods", "agreement|delete": "Delete agreements", "agreement|read": "Read agreements", "agreement|write": "Update agreements", "amenity_group|read": "Read amenity groups", "amenity|read": "Read amenities", "amenity|write": "Update amenities", "area_type|read": "Read floors", "availability|read": "Read availability", "booking|read": "Read bookings", "booking|write": "Update bookings", "brand|read": "Read brands", "category_group|read": "Read type group", "category|read": "Read type", "category|write": "Update type", "channel::booking|read": "Own channel: Read bookings", "channel::booking|write": "Own channel: Update bookings", "channel::customer|read": "Own channel: Read guests", "channel::order|read": "Own channel: Read orders", "channel::reservation|read": "Own channel: Read reservations", "channel|delete": "Delete channels", "channel|read": "Read channels", "channel|write": "Update channels", "chargeback|write": "Write chargebacks", "checkout_portal|manage": "Access to the CheckoutPortal", "city|read": "Read cities", "contact|read": "Read contacts", "contractor|read": "Read contractors", "conversation|manage": "Manage conversations", "conversation|read": "Read conversations", "cost|read": "Read costs", "customer|read": "Read guests", "customer|write": "Update guests", "dac7_report|read": "DAC7 export readout", "dac7_report|write": "DAC7 export status update", "debtor|read": "Read debtors", "discount_action|read": "Read discounts", "discount_action|write": "Update discounts", "discount_campaign|read": "Read discount campaigns", "discount_card|read": "Read discount cards", "domain|read": "Read domains", "executor|read": "Read executors", "extra_order_item|read": "Read ordered reservation extras", "extra_order_item|write": "Update ordered reservation extras", "extra|read": "Read extras", "facility|read": "Read facilities", "guest|delete": "Delete guests", "guest|read": "Read reservation guests", "guest|write": "Update guests", "internal_message|write": "Send internal messages", "inventory_object|delete": "Delete inventory objects", "inventory_object|read": "Read inventory objects", "inventory_object|write": "Update inventory objects", "invoice|read": "Read invoices", "invoice|write": "Update invoices", "journal_transaction|read": "Read journal entries", "label|read": "Read labels", "label|write": "Write labels", "ledger_account|read": "Read ledger accounts", "main_order_item|read": "Read reservation charges", "master_price_list|read": "Read price lists", "master_price_list|write": "Update price lists", "memo|write": "Add memos to reservations", "message|write": "Send message to guest", "meter_reading|read": "Read meter readings", "meter_reading|write": "Write meter readings", "meter_type|read": "Read meter types", "order|read": "Read orders", "organization|read": "Read organizations", "owner|read": "Read owners", "owner|write": "Update owners", "package_entry|read": "Read costs", "package|read": "Read packages", "payment_handler|delete": "Delete payment providers", "payment_handler|read": "Read payment providers", "payment_handler|write": "Update payment providers", "payment_method|read": "Read payment methods", "payment_method|write": "Update payment methods", "payment_request|read": "Read payment requests", "payment_request|write": "Update payment requests", "payment_result|write": "Update payment result", "payment|read": "Read payments", "payment|write": "Update payments", "peppol_delivery|read": "Read peppol deliveries", "peppol_delivery|write": "Update peppol deliveries", "period_closure|write": "Perform accounting period closures", "periodic_cost|read": "Read periodic costs", "period|read": "Read period groups", "promotion|read": "Read promotions", "question_answer|read": "Read answers", "receipt|read": "Read payment receipts", "receipt|write": "Update payment receipts", "refund_request|read": "Read refunds", "refund_result|write": "Update refund result", "region|read": "Read regions", "register|read": "Read registers", "register|write": "Update registers", "rentable_identity|delete": "Delete inventory objects", "rentable_identity|read": "Read inventory objects", "rentable_identity|write": "Write inventory objects", "rentable_segment|read": "Read segments", "rentable_type_group|read": "Read type groups", "rentable_type|read": "Read types", "rentable_type|write": "Update types", "rentable|delete": "Delete objects", "rentable|read": "Read objects", "rentable|write": "Update objects", "reservation|read": "Read reservations", "reservation|write": "Update reservations", "review_form|read": "Read review forms", "review|read": "Read reviews", "review|write": "Update reviews", "room_type|read": "Read room types", "room|read": "Read rooms", "sales/listings/amenity|read": "Read amenity", "sales/listings/price_template|delete": "Delete price templates", "sales/listings/price_template|read": "Read sales listings price templates", "sales/listings/price_template|write": "Update price templates", "sales/listings/price|read": "Read sales listings prices", "sales/listing|delete": "Delete listings", "sales/listing|read": "Read sales listings", "sales/listing|write": "Update listings", "sales/segment|delete": "Delete segments", "sales/segment|read": "Read sales segments", "sales/segment|write": "Update segments", "security_deposit_policy|read": "Read security deposit policies", "security_deposit|read": "Read security deposits", "signature|read": "Read signatures", "signature|write": "Update signatures", "special_period|read": "Read special periods", "subdomain|read": "Read subdomains", "supplier::booking|read": "Own supplier: Read bookings", "supplier::customer|read": "Own supplier: Read guests", "supplier::extra_order_item|read": "Own supplier: Read ordered reservation extras", "supplier::inventory_object|delete": "Own supplier: Delete inventory objects", "supplier::inventory_object|read": "Own supplier: Read inventory objects", "supplier::inventory_object|write": "Own supplier: Update inventory objects", "supplier::main_order_item|read": "Own supplier: Read reservation charges", "supplier::rentable_type|delete": "Own supplier: Delete types", "supplier::rentable_type|read": "Own supplier: Read types", "supplier::rentable_type|write": "Own supplier: Update types", "supplier::rentable|delete": "Own supplier: Delete objects", "supplier::rentable|read": "Own supplier: Read objects", "supplier::rentable|write": "Own supplier: Update objects", "supplier::reservation|read": "Own supplier: Read reservations", "supplier|delete": "Delete suppliers", "supplier|read": "Read suppliers", "supplier|write": "Update suppliers", "task_cost|read": "Read task costs", "task_cost|write": "Update task costs", "terms|read": "Read terms and conditions", "timesheet|delete": "Delete hourly costs", "timesheet|read": "Read hourly costs", "timesheet|write": "Update hourly costs", "todo_image|delete": "Delete todo images", "todo_image|read": "Read images for todos", "todo_image|write": "Upload todo images", "todo_invoice_item_template|read": "Read todo costs", "todo_list|read": "Read todo lists", "todo_list|write": "Update todo lists", "todo|delete": "Delete todos", "todo|read": "Read todos", "todo|write": "Update todos", "traffic_source|read": "Read traffic sources", "used_material|delete": "Delete material costs", "used_material|read": "Read material costs", "used_material|write": "Update material costs", "user|read": "Read users", "vat_code|read": "Read vat codes", "vat_tariff|read": "Read vat rates", "voucher|read": "Read vouchers", "voucher|write": "Update vouchers" } } } } }, "schemas": { "Administration": { "type": "object", "properties": { "id": { "type": "string", "description": "ID", "example": "1" }, "type": { "type": "string", "description": "Type", "example": "administration" }, "attributes": { "type": "object", "description": "Attributes", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "website": { "type": "string" }, "native_currency": { "type": "string" }, "address": { "type": "string" }, "country_code": { "type": "string" }, "postal_code": { "type": "string" }, "city": { "type": "object", "properties": { "cs": { "type": "string" }, "da-DK": { "type": "string" }, "de": { "type": "string" }, "de-AT": { "type": "string" }, "de-CH": { "type": "string" }, "en-US": { "type": "string" }, "en-GB": { "type": "string" }, "es": { "type": "string" }, "fr": { "type": "string" }, "fr-BE": { "type": "string" }, "fr-LU": { "type": "string" }, "it": { "type": "string" }, "nb": { "type": "string" }, "nl": { "type": "string" }, "nl-BE": { "type": "string" }, "pl": { "type": "string" }, "pt": { "type": "string" }, "tr": { "type": "string" }, "en": { "type": "string" }, "da": { "type": "string" } } }, "description": { "type": "object", "properties": { "cs": { "type": "string" }, "da-DK": { "type": "string" }, "de": { "type": "string" }, "de-AT": { "type": "string" }, "de-CH": { "type": "string" }, "en-US": { "type": "string" }, "en-GB": { "type": "string" }, "es": { "type": "string" }, "fr": { "type": "string" }, "fr-BE": { "type": "string" }, "fr-LU": { "type": "string" }, "it": { "type": "string" }, "nb": { "type": "string" }, "nl": { "type": "string" }, "nl-BE": { "type": "string" }, "pl": { "type": "string" }, "pt": { "type": "string" }, "tr": { "type": "string" }, "en": { "type": "string" }, "da": { "type": "string" } }, "description": "A description of the administration" }, "surroundings_description": { "type": "object", "properties": { "cs": { "type": "string" }, "da-DK": { "type": "string" }, "de": { "type": "string" }, "de-AT": { "type": "string" }, "de-CH": { "type": "string" }, "en-US": { "type": "string" }, "en-GB": { "type": "string" }, "es": { "type": "string" }, "fr": { "type": "string" }, "fr-BE": { "type": "string" }, "fr-LU": { "type": "string" }, "it": { "type": "string" }, "nb": { "type": "string" }, "nl": { "type": "string" }, "nl-BE": { "type": "string" }, "pl": { "type": "string" }, "pt": { "type": "string" }, "tr": { "type": "string" }, "en": { "type": "string" }, "da": { "type": "string" } }, "description": "A description of the surroundings" }, "tin": { "type": "string", "description": "Tax Identification Number" }, "vat_nr": { "type": "string", "description": "VAT Number" }, "available_locales": { "type": "array", "items": { "type": "string" }, "description": "Enabled locales" }, "native_locale": { "type": "string", "description": "The default locale used by the administration internally, and which should be used for communication with the administration" }, "timezone": { "type": "string", "description": "The timezone of the administration, for example: Amsterdam" }, "invoice_email": { "type": "string", "description": "The email address to contact for invoicing questions" }, "invoice_phone": { "type": "string", "description": "The phone number to contact for invoicing questions" }, "invoice_address": { "type": "string", "description": "The address to use for invoicing" }, "invoice_postalcode": { "type": "string", "description": "The postal code to use for invoicing" }, "invoice_city": { "type": "string", "description": "The city to use for invoicing" }, "invoice_country_code": { "type": "string", "description": "The country code to use for invoicing" }, "billing_vat_percentage": { "type": "integer" }, "available_currencies": { "type": "array", "items": { "type": "string" }, "description": "Enabled currencies", "readOnly": true }, "map_available": { "type": "boolean", "description": "If a map is available. The map can be used to pick a specific accommodation or pitch.", "readOnly": true }, "guest_list_group": { "type": "string", "enum": [ "main_guest", "all", "adults", "none" ], "readOnly": true }, "guest_accepted_document_type": { "type": "array", "items": { "type": "string", "enum": [ "passport", "license", "identity_card" ] }, "readOnly": true }, "guest_identification_required": { "type": "string", "enum": [ "none", "main_guest", "all", "adults" ], "readOnly": true }, "ask_for_guest_gender": { "type": "boolean", "readOnly": true }, "ask_for_guest_address": { "type": "boolean", "readOnly": true }, "ask_for_guest_postal_code": { "type": "boolean", "readOnly": true }, "ask_for_guest_city": { "type": "boolean", "readOnly": true }, "ask_for_guest_country": { "type": "boolean", "readOnly": true }, "ask_for_guest_email": { "type": "boolean", "readOnly": true }, "ask_for_guest_phone": { "type": "boolean", "readOnly": true }, "ask_for_guest_profession": { "type": "boolean", "readOnly": true }, "ask_for_guest_signature": { "type": "boolean", "readOnly": true }, "ask_for_fellow_guest_gender": { "type": "boolean", "readOnly": true }, "ask_for_fellow_guest_address": { "type": "boolean", "readOnly": true }, "ask_for_fellow_guest_postal_code": { "type": "boolean", "readOnly": true }, "ask_for_fellow_guest_city": { "type": "boolean", "readOnly": true }, "ask_for_fellow_guest_country": { "type": "boolean", "readOnly": true }, "ask_for_fellow_guest_email": { "type": "boolean", "readOnly": true }, "ask_for_fellow_guest_phone": { "type": "boolean", "readOnly": true }, "ask_for_fellow_guest_profession": { "type": "boolean", "readOnly": true }, "ask_for_fellow_guest_signature": { "type": "boolean", "readOnly": true }, "default_option_validity": { "type": "integer", "description": "The default option validity in days. When 0, customer options are not allowed.", "readOnly": true }, "max_options_per_customer": { "type": "integer", "description": "DEPRECATED use max_options_per_booker instead", "readOnly": true, "deprecated": true }, "max_options_per_booker": { "type": "integer", "description": "The maximum number of options that can be created at the same time by a particular customer", "readOnly": true }, "latitude": { "type": "number", "format": "double", "readOnly": true }, "longitude": { "type": "number", "format": "double", "readOnly": true }, "allow_multi_reservation_bookings_through_api": { "type": "boolean", "description": "Whether the administration accepts bookings containing multiple reservations.", "readOnly": true }, "accounting_closed_upto": { "type": "string", "format": "date", "description": "Date up to which accounting is closed. All financial transactions made before this date are locked and cannot be changed.", "readOnly": true }, "enable_license_plates": { "type": "boolean", "description": "Whether the administration accepts license plates for bookings.", "readOnly": true }, "iban": { "type": "string", "description": "International Bank Account Number", "readOnly": true }, "bic": { "type": "string", "description": "Bank Identifier Code", "readOnly": true }, "peppol_identifiers": { "type": "array", "items": { "type": "object", "properties": { "scheme": { "type": "string" }, "value": { "type": "string" } } }, "description": "PEPPOL Identifiers for the administration with scheme ID. See https://docs.peppol.eu/edelivery/codelists/v9.4/Peppol%20Code%20Lists%20-%20Participant%20identifier%20schemes%20v9.4.html", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } } }, "links": { "type": "object", "description": "Links", "properties": { "self": { "type": "string", "description": "Link to self" }, "url": { "type": "string", "description": "Link to url" } } }, "relationships": { "type": "object", "description": "Relationships", "properties": { "city": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "city ID" }, "type": { "type": "string", "example": "city" }, "meta": { "type": "object", "properties": { "temp_id": { "type": "string", "description": "UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known." }, "method": { "type": "string", "description": "Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update." } } } } } } }, "checkin_timetable": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "checkin_timetable ID" }, "type": { "type": "string", "example": "timetable" }, "meta": { "type": "object", "properties": { "temp_id": { "type": "string", "description": "UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known." }, "method": { "type": "string", "description": "Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update." } } } }, "readOnly": true } }, "description": "The timetable that defines the default check-in times for this administration. It can be overridden for each rentable type." }, "checkout_timetable": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "checkout_timetable ID" }, "type": { "type": "string", "example": "timetable" }, "meta": { "type": "object", "properties": { "temp_id": { "type": "string", "description": "UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known." }, "method": { "type": "string", "description": "Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update." } } } }, "readOnly": true } }, "description": "The timetable that defines the default check-out times for this administration. It can be overridden for each rentable type." }, "interactive_map": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "interactive_map ID" }, "type": { "type": "string", "example": "interactive_map" }, "meta": { "type": "object", "properties": { "temp_id": { "type": "string", "description": "UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known." }, "method": { "type": "string", "description": "Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update." } } } }, "readOnly": true } } }, "payment_handlers": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "payment_handlers ID" }, "type": { "type": "string", "example": "payment_handler" }, "meta": { "type": "object", "properties": { "temp_id": { "type": "string", "description": "UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known." }, "method": { "type": "string", "description": "Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update." } } } } }, "readOnly": true } } } } }, "meta": { "type": "object", "description": "Metadata", "properties": { "temp_id": { "type": "string", "description": "UUID for internal resource linking. Should be omitted when the relationship ID is known." } } } }, "description": "An organization can have multiple administrations, usually a holiday park or camping." }, "InteractiveMap": { "type": "object", "properties": { "id": { "type": "string", "description": "ID", "example": "1" }, "type": { "type": "string", "description": "Type", "example": "interactive_map" }, "attributes": { "type": "object", "description": "Attributes", "properties": { "tile_layer_url": { "type": "string", "description": "Returns an URL in the form \"https://app.bookingexperts.com/maps/1/{z}/map_tile_1673877961_{x}_{y}.png\": {z} — zoom level, {x} and {y} — tile coordinates" }, "max_zoom_level": { "type": "integer", "description": "Maximum value for {z} in the tile layer" }, "width": { "type": "integer", "description": "Width of the map in pixels" }, "height": { "type": "integer", "description": "Height of the map in pixels" } } }, "links": { "type": "object", "description": "Links", "properties": { "source_url": { "type": "string", "description": "A download link to the original image" } } }, "meta": { "type": "object", "description": "Metadata", "properties": { "temp_id": { "type": "string", "description": "UUID for internal resource linking. Should be omitted when the relationship ID is known." } } } }, "description": "An Administration can upload an interactive map in which rentables can be drawn. Rentables can be rendered as FeatureCollection in this map." }, "City": { "type": "object", "properties": { "id": { "type": "string", "description": "ID", "example": "1" }, "type": { "type": "string", "description": "Type", "example": "city" }, "attributes": { "type": "object", "description": "Attributes", "properties": { "name": { "type": "object", "properties": { "cs": { "type": "string" }, "da-DK": { "type": "string" }, "de": { "type": "string" }, "de-AT": { "type": "string" }, "de-CH": { "type": "string" }, "en-US": { "type": "string" }, "en-GB": { "type": "string" }, "es": { "type": "string" }, "fr": { "type": "string" }, "fr-BE": { "type": "string" }, "fr-LU": { "type": "string" }, "it": { "type": "string" }, "nb": { "type": "string" }, "nl": { "type": "string" }, "nl-BE": { "type": "string" }, "pl": { "type": "string" }, "pt": { "type": "string" }, "tr": { "type": "string" }, "en": { "type": "string" }, "da": { "type": "string" } } }, "country_code": { "type": "string", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW", "XK", "AN", "ZZ", "WW" ], "example": "NL" } } }, "relationships": { "type": "object", "description": "Relationships", "properties": { "region": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "region ID", "deprecated": true }, "type": { "type": "string", "example": "region", "deprecated": true }, "meta": { "type": "object", "properties": { "temp_id": { "type": "string", "description": "UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.", "deprecated": true }, "method": { "type": "string", "description": "Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.", "deprecated": true } }, "deprecated": true } }, "deprecated": true } }, "description": "DEPRECATED use regions instead", "deprecated": true }, "regions": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "regions ID" }, "type": { "type": "string", "example": "region" }, "meta": { "type": "object", "properties": { "temp_id": { "type": "string", "description": "UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known." }, "method": { "type": "string", "description": "Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update." } } } } } } } } } }, "meta": { "type": "object", "description": "Metadata", "properties": { "temp_id": { "type": "string", "description": "UUID for internal resource linking. Should be omitted when the relationship ID is known." } } } }, "description": "Represents a city of a Region in a country." }, "PaymentHandler": { "type": "object", "properties": { "id": { "type": "string", "description": "ID", "example": "1" }, "type": { "type": "string", "description": "Type", "example": "payment_handler" }, "attributes": { "type": "object", "description": "Attributes", "properties": { "title": { "type": "string" }, "pos_enabled": { "type": "boolean", "description": "If true, this handler can be used for POS payments" }, "supports_negative_payments": { "type": "boolean", "description": "If true, this handler can receive negative payment amounts" }, "payment_methods": { "type": "array", "items": { "type": "string", "enum": [ "american_express", "applepay", "bancontact", "banktransfer", "belfius", "creditcard", "directdebit", "eps", "giftcard", "giropay", "ideal", "inghomepay", "kbc", "klarnapaylater", "klarnasliceit", "maestro", "mastercard", "mistercash", "overboeking", "paypal", "paysafecard", "przelewy24", "sofort", "visa", "visa_electron", "vpay" ] }, "description": "Supported payment methods" }, "assigned_currencies": { "type": "array", "items": { "type": "string", "enum": [ "EUR", "USD", "CHF", "CZK", "TRY", "CVE", "XCG", "GBP", "NOK", "DKK", "ZAR" ] }, "description": "The currencies that this handler can handle", "readOnly": true }, "archived": { "type": "boolean", "description": "Whether this payment handler has been archived or not.", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } } }, "relationships": { "type": "object", "description": "Relationships", "properties": { "administration": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "administration ID" }, "type": { "type": "string", "example": "administration" }, "meta": { "type": "object", "properties": { "temp_id": { "type": "string", "description": "UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known." }, "method": { "type": "string", "description": "Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update." } } } }, "readOnly": true } } } } }, "meta": { "type": "object", "description": "Metadata", "properties": { "temp_id": { "type": "string", "description": "UUID for internal resource linking. Should be omitted when the relationship ID is known." } } } } }, "Timetable": { "type": "object", "properties": { "id": { "type": "string", "description": "ID", "example": "1" }, "type": { "type": "string", "description": "Type", "example": "timetable" }, "attributes": { "type": "object", "description": "Attributes", "properties": { "default_start": { "type": "string", "pattern": "^\\d{2}:\\d{2}$", "description": "The default check-in and check-out times for the timetable. These times will be used for any day that does not have a specific override set." }, "default_end": { "type": "string", "pattern": "^\\d{2}:\\d{2}$", "description": "The default check-in and check-out times for the timetable. These times will be used for any day that does not have a specific override set." }, "sunday_start": { "type": "string", "pattern": "^\\d{2}:\\d{2}$" }, "sunday_end": { "type": "string", "pattern": "^\\d{2}:\\d{2}$" }, "monday_start": { "type": "string", "pattern": "^\\d{2}:\\d{2}$" }, "monday_end": { "type": "string", "pattern": "^\\d{2}:\\d{2}$" }, "tuesday_start": { "type": "string", "pattern": "^\\d{2}:\\d{2}$" }, "tuesday_end": { "type": "string", "pattern": "^\\d{2}:\\d{2}$" }, "wednesday_start": { "type": "string", "pattern": "^\\d{2}:\\d{2}$" }, "wednesday_end": { "type": "string", "pattern": "^\\d{2}:\\d{2}$" }, "thursday_start": { "type": "string", "pattern": "^\\d{2}:\\d{2}$" }, "thursday_end": { "type": "string", "pattern": "^\\d{2}:\\d{2}$" }, "friday_start": { "type": "string", "pattern": "^\\d{2}:\\d{2}$" }, "friday_end": { "type": "string", "pattern": "^\\d{2}:\\d{2}$" }, "saturday_start": { "type": "string", "pattern": "^\\d{2}:\\d{2}$" }, "saturday_end": { "type": "string", "pattern": "^\\d{2}:\\d{2}$" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } } }, "meta": { "type": "object", "description": "Metadata", "properties": { "temp_id": { "type": "string", "description": "UUID for internal resource linking. Should be omitted when the relationship ID is known." } } } }, "description": "A Timetable is used to define check-in and check-out times for an Administration or RentableType.\nIt has a default check-in and check-out time, and can optionally have overrides for specific weekdays. If a weekday override is not set, the default times will be used for that day.\n" } }, "responses": { "AdministrationCollectionResponse": { "description": "AdministrationCollectionResponse", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Administration" } }, "included": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/City" }, { "$ref": "#/components/schemas/Timetable" }, { "$ref": "#/components/schemas/Timetable" }, { "$ref": "#/components/schemas/InteractiveMap" }, { "$ref": "#/components/schemas/PaymentHandler" } ] } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "total_records": { "type": "integer" }, "page": { "type": "integer" }, "size": { "type": "integer" } } } } } } } } } }, "Error": { "description": "Error", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string", "description": "HTTP response code" }, "code": { "type": "string", "description": "Internal error code" }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error details" }, "source": { "type": "object", "properties": { "pointer": { "type": "string", "description": "Pointer to error in resource" } } } } } } } } } } } } } } ```