Saltar al contenido

Organizations

Organizations, which own all other data. An API key gives access to a single organization

Endpoints
GET/organizations

The organization object

Attributes

iduuid

Unique identifier

clover_merchant_idtext | null

Identifier of the connected Clover merchant

mollie_profile_idtext | null

Identifier of the connected Mollie profile

paddle_subscription_idtext | null
paddle_subscriptions.id

Identifier of the Paddle subscription of the organization

referrer_iduuid | null
user_profiles.user_id

Identifier of the user that referred the organization

square_location_idtext | null

Identifier of the connected Square location

stripe_account_idtext | null

Identifier of the connected Stripe account

created_atread-onlytimestamp with time zone

Creation timestamp

updated_atread-onlytimestamp with time zone

Last modification timestamp

deleted_attimestamp with time zone | null

Timestamp at which the organization was deleted

activeboolean

Whether the organization is active. Widgets, sites and iCal feeds of inactive organizations don't work

arrival_labelMultiLanguageString

Localized label for the arrival date

avatartext | null

URL of the avatar image

booking_form_ctaMultiLanguageString

Localized label of the booking form's submit button

buyer_labelMultiLanguageString

Localized label of the buyer details on invoices

color_backgroundtext

Background color of the guest page and emails

color_errortext

Error color of the guest page and emails

color_headertext

Header color of the guest page and emails

color_infotext

Info color of the guest page and emails

color_primarytext

Primary color of the guest page and emails

color_texttext

Text color of the guest page and emails

color_warningtext

Warning color of the guest page and emails

company_nametext

Company name of the organization, for invoices

confirmation_messageMultiLanguageString

Localized message shown after submitting a booking

confirmation_message_titleMultiLanguageString

Localized title of the message shown after submitting a booking

contact_detailsArray<ContactDetail>

Contact details shown to guests

country_codeCountryCode | ""

ISO 3166-1 alpha-2 country code of the organization, or empty

creditinteger

Pre-paid credit balance of the organization, in cents

custom_domaintext | null

Custom domain of the guest page

departure_labelMultiLanguageString

Localized label for the departure date

descriptionMultiLanguageString

Localized description of the organization

e_invoice_addresstext

E-invoicing address of the organization

e_invoice_schemetext

Scheme of the organization's e-invoicing address, e.g. a Peppol scheme

expires_attimestamp with time zone | null

Timestamp at which the trial or subscription expires

fonttext | null

Font of the guest page and emails

from_addresstext | null

Email address emails to guests are sent from

from_nametext | null

Sender name of emails to guests

ftsread-onlytsvector

Full text search index

ical_export_secrettext

Secret used to generate iCal feed URLs

ical_export_secret_no_detailstext

Secret used to generate iCal feed URLs without booking details

initial_review_statusReviewStatus

Status of new reviews: pending or approved

invoice_detailstext

Seller details shown on invoices, such as address and VAT number

invoice_footertext

Text shown at the bottom of invoices

languages[Language, ...Array<Language>]

Languages the organization supports, the first being the default

logotext | null

URL of the logo image

logo_alttext | null

URL of the logo image for dark backgrounds

logo_sizeinteger | null

Size of the logo in pixels, or null for automatic

nameMultiLanguageString

Localized name of the organization

onboarding_progress{ booking?: string | null, channel?: string | null, event?: string | null, impression?: string | null, product?: string | null }

Progress of the organization through onboarding

payment_detailsMultiLanguageString

Localized payment instructions for manual payments

payment_methodPaymentMethod

Payment provider for online payments

periodSubscriptionPeriod

Billing period of the subscription

pricing_versionOrganizationPricingVersion

Version of Bookingmood's pricing that applies to the organization and its units. Versions were introduced as the pricing changed over time

review_promptMultiLanguageString

Localized message asking guests to leave a review

seller_labelMultiLanguageString

Localized label of the seller details on invoices

show_branding_booking_status_pageboolean

Whether to show the Bookingmood branding on the guest page

show_review_promptboolean

Whether the guest page asks for a review after the stay

sms_limitinteger

Maximum number of text messages the organization can send per day

stripe_store_payment_detailsboolean

Whether to store guests' payment details with Stripe for future charges

subscription_typeSubscriptionType

How the subscription is paid: trial, paddle, pre-paid or test

thread_emailsboolean

Whether emails about the same booking are grouped in a single thread

tierTier

Subscription tier of the organization

vat_numbertext

VAT number of the organization

Related resources

Embed related resources in the response with the select parameter, for example select=*,paddle_subscriptions!paddle_subscription_id(*). Resources related through more than one column need the column as a hint, like table!column(*).

paddle_subscriptions!paddle_subscription_id(*)object | null
paddle_subscriptions

The paddle subscription referenced by paddle_subscription_id.

user_profiles!referrer_id(*)object | null
user_profiles

The user profile referenced by referrer_id.

attributes(*)array
attributes

The attributes referencing this organization through attributes.organization_id.

bookings!organization_id(*)array
bookings

The bookings referencing this organization through bookings.organization_id.

calendar_events!organization_id(*)array
calendar_events

The calendar events referencing this organization through calendar_events.organization_id.

capacity_groups(*)array
capacity_groups

The capacity groups referencing this organization through capacity_groups.organization_id.

contacts(*)array
contacts

The contacts referencing this organization through contacts.organization_id.

coupons(*)array
coupons

The coupons referencing this organization through coupons.organization_id.

invoices(*)array
invoices

The invoices referencing this organization through invoices.organization_id.

members(*)array
members

The members referencing this organization through members.organization_id.

message_templates(*)array
message_templates

The message templates referencing this organization through message_templates.organization_id.

organization_calendar_logs(*)array
organization_calendar_logs

The organization calendar logs referencing this organization through organization_calendar_logs.organization_id.

paddle_subscriptions!organization_id(*)array
paddle_subscriptions

The paddle subscriptions referencing this organization through paddle_subscriptions.organization_id.

pricing_widgets(*)array
pricing_widgets

The pricing widgets referencing this organization through pricing_widgets.organization_id.

products!organization_id(*)array
products

The products referencing this organization through products.organization_id.

reply_to_addresses(*)array
reply_to_addresses

The reply to addresses referencing this organization through reply_to_addresses.organization_id.

review_widgets(*)array
review_widgets

The review widgets referencing this organization through review_widgets.organization_id.

reviews(*)array
reviews

The reviews referencing this organization through reviews.organization_id.

seasons(*)array
seasons

The seasons referencing this organization through seasons.organization_id.

services(*)array
services

The services referencing this organization through services.organization_id.

sites!organization_id(*)array
sites

The sites referencing this organization through sites.organization_id.

taxes(*)array
taxes

The taxes referencing this organization through taxes.organization_id.

webhooks(*)array
webhooks

The webhooks referencing this organization through webhooks.organization_id.

widgets!organization_id(*)array
widgets

The widgets referencing this organization through widgets.organization_id.

The organization object
JSON
{
  "id": "00000000-0000-0000-0000-000000000000",
  "clover_merchant_id": "",
  "mollie_profile_id": "",
  "paddle_subscription_id": "",
  "referrer_id": "00000000-0000-0000-0000-000000000000",
  "square_location_id": "",
  "stripe_account_id": "",
  "created_at": "2026-10-30T23:21:07.688Z",
  "updated_at": "2026-10-30T23:21:07.688Z",
  "deleted_at": "2026-10-30T23:21:07.688Z",
  "active": true,
  "arrival_label": {},
  "avatar": "",
  "booking_form_cta": {},
  "buyer_label": {},
  "color_background": "#fff",
  "color_error": "#faa5a5",
  "color_header": "#000",
  "color_info": "#2463eb",
  "color_primary": "#059669",
  "color_text": "#000",
  "color_warning": "#a75c03",
  "company_name": "Summer cottage",
  "confirmation_message": {},
  "confirmation_message_title": {},
  "contact_details": {},
  "country_code": "NL",
  "credit": 0,
  "custom_domain": "",
  "departure_label": {},
  "description": {},
  "e_invoice_address": "",
  "e_invoice_scheme": "",
  "expires_at": "2026-10-30T23:21:07.688Z",
  "font": "",
  "from_address": "",
  "from_name": "Summer cottage",
  "ical_export_secret": "md5((random())::text)",
  "ical_export_secret_no_details": "md5((random())::text)",
  "initial_review_status": "pending",
  "invoice_details": "",
  "invoice_footer": "",
  "languages": [
    ""
  ],
  "logo": "",
  "logo_alt": "",
  "logo_size": 0,
  "name": {},
  "onboarding_progress": {},
  "payment_details": {},
  "payment_method": "manual",
  "period": "monthly",
  "pricing_version": "V5",
  "review_prompt": {},
  "seller_label": {},
  "show_branding_booking_status_page": true,
  "show_review_prompt": true,
  "sms_limit": 0,
  "stripe_store_payment_details": false,
  "subscription_type": "trial",
  "thread_emails": true,
  "tier": "premium",
  "vat_number": ""
}
Including related resources
curl -X GET "https://api.bookingmood.com/v1/organizations?limit=10&select=*,paddle_subscriptions!paddle_subscription_id(*),user_profiles!referrer_id(*)" \
  -H "Authorization: Bearer YOUR_API_KEY"

List organizations

Filters

idFilter<uuid>

Unique identifier

clover_merchant_idFilter<text | null>

Identifier of the connected Clover merchant

mollie_profile_idFilter<text | null>

Identifier of the connected Mollie profile

paddle_subscription_idFilter<text | null>
paddle_subscriptions.id

Identifier of the Paddle subscription of the organization

referrer_idFilter<uuid | null>
user_profiles.user_id

Identifier of the user that referred the organization

square_location_idFilter<text | null>

Identifier of the connected Square location

stripe_account_idFilter<text | null>

Identifier of the connected Stripe account

created_atFilter<timestamp with time zone>

Creation timestamp

updated_atFilter<timestamp with time zone>

Last modification timestamp

deleted_atFilter<timestamp with time zone | null>

Timestamp at which the organization was deleted

activeFilter<boolean>

Whether the organization is active. Widgets, sites and iCal feeds of inactive organizations don't work

arrival_labelFilter<MultiLanguageString>

Localized label for the arrival date

avatarFilter<text | null>

URL of the avatar image

booking_form_ctaFilter<MultiLanguageString>

Localized label of the booking form's submit button

buyer_labelFilter<MultiLanguageString>

Localized label of the buyer details on invoices

color_backgroundFilter<text>

Background color of the guest page and emails

color_errorFilter<text>

Error color of the guest page and emails

color_headerFilter<text>

Header color of the guest page and emails

color_infoFilter<text>

Info color of the guest page and emails

color_primaryFilter<text>

Primary color of the guest page and emails

color_textFilter<text>

Text color of the guest page and emails

color_warningFilter<text>

Warning color of the guest page and emails

company_nameFilter<text>

Company name of the organization, for invoices

confirmation_messageFilter<MultiLanguageString>

Localized message shown after submitting a booking

confirmation_message_titleFilter<MultiLanguageString>

Localized title of the message shown after submitting a booking

contact_detailsFilter<Array<ContactDetail>>

Contact details shown to guests

country_codeFilter<CountryCode | "">

ISO 3166-1 alpha-2 country code of the organization, or empty

creditFilter<integer>

Pre-paid credit balance of the organization, in cents

custom_domainFilter<text | null>

Custom domain of the guest page

departure_labelFilter<MultiLanguageString>

Localized label for the departure date

descriptionFilter<MultiLanguageString>

Localized description of the organization

e_invoice_addressFilter<text>

E-invoicing address of the organization

e_invoice_schemeFilter<text>

Scheme of the organization's e-invoicing address, e.g. a Peppol scheme

expires_atFilter<timestamp with time zone | null>

Timestamp at which the trial or subscription expires

fontFilter<text | null>

Font of the guest page and emails

from_addressFilter<text | null>

Email address emails to guests are sent from

from_nameFilter<text | null>

Sender name of emails to guests

ftsFilter<tsvector>

Full text search index

ical_export_secretFilter<text>

Secret used to generate iCal feed URLs

ical_export_secret_no_detailsFilter<text>

Secret used to generate iCal feed URLs without booking details

initial_review_statusFilter<ReviewStatus>

Status of new reviews: pending or approved

invoice_detailsFilter<text>

Seller details shown on invoices, such as address and VAT number

invoice_footerFilter<text>

Text shown at the bottom of invoices

languagesFilter<[Language, ...Array<Language>]>

Languages the organization supports, the first being the default

logoFilter<text | null>

URL of the logo image

logo_altFilter<text | null>

URL of the logo image for dark backgrounds

logo_sizeFilter<integer | null>

Size of the logo in pixels, or null for automatic

nameFilter<MultiLanguageString>

Localized name of the organization

onboarding_progressFilter<{ booking?: string | null, channel?: string | null, event?: string | null, impression?: string | null, product?: string | null }>

Progress of the organization through onboarding

payment_detailsFilter<MultiLanguageString>

Localized payment instructions for manual payments

payment_methodFilter<PaymentMethod>

Payment provider for online payments

periodFilter<SubscriptionPeriod>

Billing period of the subscription

pricing_versionFilter<OrganizationPricingVersion>

Version of Bookingmood's pricing that applies to the organization and its units. Versions were introduced as the pricing changed over time

review_promptFilter<MultiLanguageString>

Localized message asking guests to leave a review

seller_labelFilter<MultiLanguageString>

Localized label of the seller details on invoices

show_branding_booking_status_pageFilter<boolean>

Whether to show the Bookingmood branding on the guest page

show_review_promptFilter<boolean>

Whether the guest page asks for a review after the stay

sms_limitFilter<integer>

Maximum number of text messages the organization can send per day

stripe_store_payment_detailsFilter<boolean>

Whether to store guests' payment details with Stripe for future charges

subscription_typeFilter<SubscriptionType>

How the subscription is paid: trial, paddle, pre-paid or test

thread_emailsFilter<boolean>

Whether emails about the same booking are grouped in a single thread

tierFilter<Tier>

Subscription tier of the organization

vat_numberFilter<text>

VAT number of the organization

Responses

200

A list of organizations with the selected columns

206

Partial Content

400

The request is malformed, for example an unknown column or an invalid filter.

401

The API key is missing or invalid.

Error responses have a JSON body with a code, message, details and hint. See the introduction for more on errors.
GET /organizations
curl -X GET "https://api.bookingmood.com/v1/organizations?select=*&limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"
Example response
JSON
[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "clover_merchant_id": "",
    "mollie_profile_id": "",
    "paddle_subscription_id": "",
    "referrer_id": "00000000-0000-0000-0000-000000000000",
    "square_location_id": "",
    "stripe_account_id": "",
    "created_at": "2026-10-30T23:21:07.688Z",
    "updated_at": "2026-10-30T23:21:07.688Z",
    "deleted_at": "2026-10-30T23:21:07.688Z",
    "active": true,
    "arrival_label": {},
    "avatar": "",
    "booking_form_cta": {},
    "buyer_label": {},
    "color_background": "#fff",
    "color_error": "#faa5a5",
    "color_header": "#000",
    "color_info": "#2463eb",
    "color_primary": "#059669",
    "color_text": "#000",
    "color_warning": "#a75c03",
    "company_name": "Summer cottage",
    "confirmation_message": {},
    "confirmation_message_title": {},
    "contact_details": {},
    "country_code": "NL",
    "credit": 0,
    "custom_domain": "",
    "departure_label": {},
    "description": {},
    "e_invoice_address": "",
    "e_invoice_scheme": "",
    "expires_at": "2026-10-30T23:21:07.688Z",
    "font": "",
    "from_address": "",
    "from_name": "Summer cottage",
    "ical_export_secret": "md5((random())::text)",
    "ical_export_secret_no_details": "md5((random())::text)",
    "initial_review_status": "pending",
    "invoice_details": "",
    "invoice_footer": "",
    "languages": [
      ""
    ],
    "logo": "",
    "logo_alt": "",
    "logo_size": 0,
    "name": {},
    "onboarding_progress": {},
    "payment_details": {},
    "payment_method": "manual",
    "period": "monthly",
    "pricing_version": "V5",
    "review_prompt": {},
    "seller_label": {},
    "show_branding_booking_status_page": true,
    "show_review_prompt": true,
    "sms_limit": 0,
    "stripe_store_payment_details": false,
    "subscription_type": "trial",
    "thread_emails": true,
    "tier": "premium",
    "vat_number": ""
  }
]

Toma el control de tus reservas. Crea tu propio negocio.

Únete a más de 1200 empresas independientes de alquiler vacacional que utilizan Bookingmood para aumentar las reservas directas y fortalecer la relación con los huéspedes.

Comienza tu prueba gratuita de 14 días