Booking

List bookings

get

List all bookings

Query parameters

Responses

200

A list of bookings

application/json

idstring · uuidRead-onlyOptional

referencestringOptionalExample: 2025-0201

reference_yearstringOptionalExample: 2025

reference_numberstringOptionalExample: 0201

reference_suffixstringOptional

starts_atstring · date-timeOptional

ends_atstring · date-timeOptional

statusstring · enumOptionalPossible values:

booker_idstring · uuidOptional

check_in_statusstring · enumOptionalPossible values:

check_out_statusstring · enumOptionalPossible values:

web_check_in_statusstring · enumOptionalPossible values:

currencystring · iso-4217Optional

commission_valuenumber · floatOptional

commission_percentagenumber · floatOptional

channelstring · enumOptionalPossible values:

custom_fieldsobject · jsonOptional

paxintegerOptionalExample: 2

is_last_minutebooleanOptional

payerobject · enumOptionalPossible values:

total_price_excl_taxnumber · floatOptional

total_price_incl_taxnumber · floatOptional

discount_totalnumber · floatOptional

final_price_excl_taxnumber · floatOptional

final_price_incl_taxnumber · floatOptional

tax_componentnumber · floatOptional

final_tax_componentnumber · floatOptional

invoiced_totalnumber · floatOptional

credited_totalnumber · floatOptional

due_amountnumber · floatOptional

paid_amountnumber · floatOptional

refund_amountnumber · floatOptional

amount_to_refundnumber · floatOptional

cancellation_fee_amountnumber · floatOptional

cancellation_fee_percentagenumber · floatOptional

google_analytics_client_idstring · nullableOptional

duration_in_daysintegerOptional

duration_in_nightsintegerOptional

expired_atstring · date-timeOptional

cancelled_atstring · date-timeOptional

expires_atstring · date-time · nullableOptional

created_atstring · date-timeRead-onlyOptional

updated_atstring · date-timeRead-onlyOptional

get

/bookings

HTTPcURLJavaScriptPython

GET /private/bookings HTTP/1.1
Host: api.bookinglayer.io
Accept: */*

200

A list of bookings

[
  {
    "web_check_in_status": "nobody",
    "cancelled_at": "2000-01-23T04:56:07.000+00:00",
    "starts_at": "2000-01-23T04:56:07.000+00:00",
    "discount_total": 5.637377,
    "total_price_incl_tax": 5.962134,
    "invoiced_total": 2.027123,
    "amount_to_refund": 1.4894159,
    "channel": "partner",
    "is_last_minute": true,
    "created_at": "2000-01-23T04:56:07.000+00:00",
    "expired_at": "2000-01-23T04:56:07.000+00:00",
    "payer": "{}",
    "google_analytics_client_id": "google_analytics_client_id",
    "reference": "2025-0201",
    "reference_suffix": "",
    "duration_in_days": 1,
    "expires_at": "2000-01-23T04:56:07.000+00:00",
    "updated_at": "2000-01-23T04:56:07.000+00:00",
    "check_in_status": "nobody",
    "commission_value": 0.8008282,
    "final_price_excl_tax": 2.302136,
    "refund_amount": 1.0246457,
    "currency": "currency",
    "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "ends_at": "2000-01-23T04:56:07.000+00:00",
    "total_price_excl_tax": 1.4658129,
    "tax_component": 9.301444,
    "final_price_incl_tax": 7.0614014,
    "check_out_status": "nobody",
    "commission_percentage": 6.0274563,
    "custom_fields": "{}",
    "pax": 2,
    "booker_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "cancellation_fee_amount": 6.846853,
    "final_tax_component": 3.6160767,
    "reference_number": "0201",
    "cancellation_fee_percentage": 7.4577446,
    "reference_year": "2025",
    "due_amount": 7.386282,
    "paid_amount": 1.2315135,
    "credited_total": 4.145608,
    "status_log": [
      {
        "date": "2000-01-23T04:56:07.000+00:00",
        "status": "draft"
      },
      {
        "date": "2000-01-23T04:56:07.000+00:00",
        "status": "draft"
      }
    ],
    "duration_in_nights": 4,
    "status": "draft"
  }
]

Get a booking by ID

get

Get a booking by ID

Path parameters

booking_idstring · uuidRequired

ID of the booking to get

Query parameters

Responses

200

The booking

application/json

idstring · uuidRead-onlyOptional

referencestringOptionalExample: 2025-0201

reference_yearstringOptionalExample: 2025

reference_numberstringOptionalExample: 0201

reference_suffixstringOptional

starts_atstring · date-timeOptional

ends_atstring · date-timeOptional

statusstring · enumOptionalPossible values:

booker_idstring · uuidOptional

check_in_statusstring · enumOptionalPossible values:

check_out_statusstring · enumOptionalPossible values:

web_check_in_statusstring · enumOptionalPossible values:

currencystring · iso-4217Optional

commission_valuenumber · floatOptional

commission_percentagenumber · floatOptional

channelstring · enumOptionalPossible values:

custom_fieldsobject · jsonOptional

paxintegerOptionalExample: 2

is_last_minutebooleanOptional

payerobject · enumOptionalPossible values:

total_price_excl_taxnumber · floatOptional

total_price_incl_taxnumber · floatOptional

discount_totalnumber · floatOptional

final_price_excl_taxnumber · floatOptional

final_price_incl_taxnumber · floatOptional

tax_componentnumber · floatOptional

final_tax_componentnumber · floatOptional

invoiced_totalnumber · floatOptional

credited_totalnumber · floatOptional

due_amountnumber · floatOptional

paid_amountnumber · floatOptional

refund_amountnumber · floatOptional

amount_to_refundnumber · floatOptional

cancellation_fee_amountnumber · floatOptional

cancellation_fee_percentagenumber · floatOptional

google_analytics_client_idstring · nullableOptional

duration_in_daysintegerOptional

duration_in_nightsintegerOptional

expired_atstring · date-timeOptional

cancelled_atstring · date-timeOptional

expires_atstring · date-time · nullableOptional

created_atstring · date-timeRead-onlyOptional

updated_atstring · date-timeRead-onlyOptional

get

/bookings/{booking_id}

HTTPcURLJavaScriptPython

GET /private/bookings/{booking_id} HTTP/1.1
Host: api.bookinglayer.io
Accept: */*

200

The booking

{
  "web_check_in_status": "nobody",
  "cancelled_at": "2000-01-23T04:56:07.000+00:00",
  "starts_at": "2000-01-23T04:56:07.000+00:00",
  "discount_total": 5.637377,
  "total_price_incl_tax": 5.962134,
  "invoiced_total": 2.027123,
  "amount_to_refund": 1.4894159,
  "channel": "partner",
  "is_last_minute": true,
  "created_at": "2000-01-23T04:56:07.000+00:00",
  "expired_at": "2000-01-23T04:56:07.000+00:00",
  "payer": "{}",
  "google_analytics_client_id": "google_analytics_client_id",
  "reference": "2025-0201",
  "reference_suffix": "",
  "duration_in_days": 1,
  "expires_at": "2000-01-23T04:56:07.000+00:00",
  "updated_at": "2000-01-23T04:56:07.000+00:00",
  "check_in_status": "nobody",
  "commission_value": 0.8008282,
  "final_price_excl_tax": 2.302136,
  "refund_amount": 1.0246457,
  "currency": "currency",
  "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "ends_at": "2000-01-23T04:56:07.000+00:00",
  "total_price_excl_tax": 1.4658129,
  "tax_component": 9.301444,
  "final_price_incl_tax": 7.0614014,
  "check_out_status": "nobody",
  "commission_percentage": 6.0274563,
  "custom_fields": "{}",
  "pax": 2,
  "booker_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "cancellation_fee_amount": 6.846853,
  "final_tax_component": 3.6160767,
  "reference_number": "0201",
  "cancellation_fee_percentage": 7.4577446,
  "reference_year": "2025",
  "due_amount": 7.386282,
  "paid_amount": 1.2315135,
  "credited_total": 4.145608,
  "status_log": [
    {
      "date": "2000-01-23T04:56:07.000+00:00",
      "status": "draft"
    },
    {
      "date": "2000-01-23T04:56:07.000+00:00",
      "status": "draft"
    }
  ],
  "duration_in_nights": 4,
  "status": "draft"
}