List all reservations

Updated:

GET/property/{connection_id}/reservation

Returns a list of PropertyReservations. Narrow the results with the query parameters before paging, then page through them with limit and offset (the default and maximum page size depend on the integration). Use fields to return only the fields you need and reduce the response size. When the integration supports a total count, it is returned in the X-Total-Count response header. Use each item's id to retrieve, update, or delete it where those operations are supported.

Parameters

limitnumber default=100
offsetnumber default=0
updated_gtedate-time
Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
sort enum
order enum
querystring
Query string to search. eg. email address or name
listing_idstring
The property listing ID to filter by
guest_idstring
The guest ID to filter by
status enum
start_gtestring
The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_ltstring
The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection

Returns

idstring
unique identifier for the reservation
created_atdate-time
when the reservation was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
when the reservation was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
listing_idstring
pointer to the Property Listing that is booked
unittype_idsstring array
Property Unittypes (room types) that are booked
guest_idstring
pointer to the Property Guest who made the reservation
guest_namestring
the primary guest full name
guest_emailstring
the primary guest email address
guest_phonestring
the primary guest telephone number
status enum
Valid values:
"INQUIRY"
"PENDING"
"CONFIRMED"
"CANCELLED"
"CHECKED_IN"
the reservation status
sourcestring
the booking channel, eg. Airbnb, Booking.com or direct
confirmation_codestring
the booking channel confirmation code
start_atdate-time
the arrival (check-in) date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atdate-time
the departure (check-out) date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
estimated_arrival_timestring
the guest estimated arrival time (HH:mm, local time)
estimated_departure_timestring
the guest estimated departure time (HH:mm, local time)
nightsnumber
number of nights
guestsnumber
total number of guests
adultsnumber
number of adults
childrennumber
number of children
infantsnumber
number of infants
petsnumber
number of pets
currencystring
ISO 4217 currency code
total_amountnumber
the total price of the reservation
paid_amountnumber
the amount already paid
balance_amountnumber
the remaining balance
line_items array
price breakdown (base price, fees, taxes, discounts)
notesstring
free-text notes about the reservation
cancelled_atdate-time
when the reservation was cancelled (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
web_urlstring
the reservation URL
metadata array
custom field values

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'GET',
  url: 'https://api.unified.to/property/5de520f96e439b002043d8dc/reservation',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    limit: 50,
    offset: 0,
    updated_gte: '2026-01-01T00:00:00.000Z',
    sort: 'updated_at',
    order: 'asc',
    query: '',
    listing_id: '',
    guest_id: '',
    status: '',
    start_gte: '',
    end_lt: '',
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?