# Search for bookings

Search for bookings via a variety of optional filters within the Property Management System (PMS). This endpoint allows you to filter bookings based on date ranges, statuses, unit IDs, booking contact IDs, and other criteria, providing a flexible way to retrieve specific booking information as needed.

Endpoint: GET /api/v3/bookings
Version: 3.0.4
Security: OAuth2

## Query parameters:

  - `dateFrom` (string)
    Start of date range for which bookings are retrieved, based on start and end date of booking

  - `dateTo` (string)
    End of date range for which bookings are retrieved, based on start and end date of booking

  - `lastUpdatedFrom` (string)
    Timestamp of the last update to the booking, returns bookings updated after this timestamp

  - `lastUpdatedTo` (string)
    Timestamp of the last update to the booking, returns bookings updated before this timestamp

  - `createdFrom` (string)
    Timestamp of the booking creation, returns bookings created after this timestamp

  - `createdTo` (string)
    Timestamp of the booking creation, returns bookings created before this timestamp

  - `unitId` (integer)
    ID of the unit

  - `bookingContactId` (integer)
    ID of the booking contact

  - `bookingAccountId` (integer)
    ID of the booking account

  - `billingAccountId` (integer)
    ID of the billing account

  - `statuses` (array)
    Array of statuses for the booking

  - `bookingReference` (string)
    Booking reference number

  - `channelId` (integer)
    ID of the channel

  - `bookingId` (integer)
    ID of the booking

  - `otaReference` (string)
    The ota reference is the booking reference provided by the online travel agent and should match the reference shown on the customer’s confirmation from the 3rd party

  - `customerReference` (string)
    Customer reference of booking

  - `organisationSettingsId` (integer)
    ID of the organisation settings

## Response 200 fields (application/json):

  - `content` (array)

  - `content.organisationSettingsName` (string)
    The name of the organisation for the room stay

  - `content.organisationSettingsId` (integer)
    The id of the organisation for the room stay

  - `content.roomStayId` (integer)
    The id of the room stay

  - `content.unit` (object)
    The unit of the room stay

  - `content.unit.name` (string)
    Unit Name

  - `content.unit.id` (integer)
    Unit ID

  - `content.unit.buildingName` (string)
    Unit Type ID

  - `content.startDate` (string)
    The start date of the room stay

  - `content.endDate` (string)
    The end date of the room stay

  - `content.netAmount` (number)
    The net amount of the room stay

  - `content.vatAmount` (number)
    The VAT amount of the room stay

  - `content.bookingId` (integer)
    The id of the booking

  - `content.channelId` (integer)
    The id of the channel for the booking

  - `content.channelName` (string)
    The name of the channel for the booking

  - `content.otaReference` (string)
    The ota reference for the booking

  - `content.bookingAccount` (object)
    The projected finance account

  - `content.bookingAccount.id` (integer)
    The unique identifier of the account

  - `content.bookingAccount.company` (object)
    The company of the account

  - `content.bookingAccount.company.id` (integer)
    Unique identifier of the company

  - `content.bookingAccount.company.companyName` (string)
    Name of the company

  - `content.bookingAccount.accountCode` (string)
    The code of the account

  - `content.bookingAccount.contact` (object)
    The name of the account

  - `content.bookingAccount.contact.id` (integer)
    Unique identifier of the contact

  - `content.bookingAccount.contact.firstName` (string)
    First name of the contact

  - `content.bookingAccount.contact.lastName` (string)
    Last name of the contact

  - `content.bookingAccount.contact.telephoneNumber` (string)
    Telephone number of the contact

  - `content.bookingAccount.contact.emailAddress` (string)
    Email address of the contact

  - `content.bookingReference` (string)
    The reference of the booking

  - `content.roomStayStatus` (string)
    The status of the room stay

  - `content.customerReference` (string)
    The customer reference for the booking

  - `content.bookingContact` (object)
    The name of the account

  - `content.billingAccount` (object)
    The projected finance account

  - `page` (object)

  - `page.size` (integer)

  - `page.totalElements` (integer)

  - `page.totalPages` (integer)

  - `page.number` (integer)