Index reservations

get https://cdp.bookboost.io/api/v1/reservations

Index reservations.

Query Params

limit

integer

filter

json

sort

string

Must not be greater than 255 characters.

date

string

Must be a valid date. Must not be greater than 255 characters.

filter[guest_id]

integer

filter[guest_uuid]

string

validation.uuid.

filter[booking_reference]

string

Must not be greater than 255 characters.

filter[guest_first_name]

string

Must not be greater than 255 characters.

filter[guest_last_name]

string

Must not be greater than 255 characters.

filter[time_frame]

string

Must not be greater than 255 characters.

filter[properties]

string

Must not be greater than 255 characters.

filter[booked_at]

string

Specify this value to filter from date, or use the character ";" to specify a filter between two dates.

filter[start]

string

Start date of booking. Specify this value to filter from date, or use the character ";" to specify a filter between two dates.

filter[end]

string

End date of booking. Specify this value to filter from date, or use the character ";" to specify a filter between two dates.

filter[created_at]

string

Specify this value to filter from date, or use the character ";" to specify a filter between two dates.

filter[updated_at]

string

Specify this value to filter from date, or use the character ";" to specify a filter between two dates.

Response

Response body

object

data

array of objects

data

object

uuid

string of objects

status

string of objects

arrival_date_time

string of objects

departure_date_time

string of objects

number_of_adults

integer of objects

number_of_children

integer of objects

start

string of objects

end

string of objects

cancelled

string of objects

booking_reference

string of objects

updated_at

string of objects

created_at

string of objects

created_at_in_pms

string of objects

property_uuid

integer of objects

rate_plans

array of objects

rate_plans

object

pms

string of objects

pms_link

string of objects

balance

integer of objects

balance_paid

boolean of objects

currency

string of objects

total_gross_amount

integer of objects

total_tax

integer of objects

subtotal

integer of objects

purpose

string of objects

market_segment

string of objects

market_category

string of objects

channel_segment

string of objects

channel_category

string of objects

agency_name

string of objects

transport_method

string of objects

booked_space_types

array of objects

booked_space_types

object

charged_space_types

array of objects

charged_space_types

object

users

array of objects

users

object

integer of objects

role

string of objects

first_name

string of objects

middle_name

string of objects

last_name

string of objects

phone

string of objects

phones

array of objects

phones

object

loyalty_programme_memberships

array of objects

loyalty_programme_memberships

object

string of objects

emails

array of objects

emails

object

segments

array of objects

segments

object

salutation

string of objects

title

string of objects

gender

string of objects

country_code

string of objects

language_code

string of objects

state

string of objects

connector

object

external_references

array of objects

external_references

object

reference

string of objects

external_system

object

links

object

first

string of objects

last

string of objects

200success