Retrieve a reservation

Updated: October 29, 2026

GET/property/{connection_id}/reservation/{id}

Retrieves a single PropertyReservation by its id. Obtain id values from the corresponding list endpoint. Use fields to return only the fields you need.

Parameters

Returns

PropertyReservation

Response field	Type	Required	Description
`id`	string	No	unique identifier for the reservation
`created_at`	string (date-time)	No	when the reservation was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`updated_at`	string (date-time)	No	when the reservation was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`listing_id`	string	No	pointer to the Property Listing that is booked
`unittype_ids`	string[]	No	Property Unittypes (room types) that are booked
`guest_id`	string	No	pointer to the Property Guest who made the reservation
`guest_name`	string	No	the primary guest full name
`guest_email`	string	No	the primary guest email address
`guest_phone`	string	No	the primary guest telephone number
`status`	enum	No	the reservation status Values: `INQUIRY`, `PENDING`, `CONFIRMED`, `CANCELLED`, `CHECKED_IN`, `CHECKED_OUT`, `NO_SHOW`, `OTHER`
`source`	string	No	the booking channel, eg. Airbnb, Booking.com or direct
`confirmation_code`	string	No	the booking channel confirmation code
`start_at`	string (date-time)	No	the arrival (check-in) date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`end_at`	string (date-time)	No	the departure (check-out) date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`estimated_arrival_time`	string	No	the guest estimated arrival time (HH:mm, local time)
`estimated_departure_time`	string	No	the guest estimated departure time (HH:mm, local time)
`nights`	number	No	number of nights
`guests`	number	No	total number of guests
`adults`	number	No	number of adults
`children`	number	No	number of children
`infants`	number	No	number of infants
`pets`	number	No	number of pets
`currency`	string	No	ISO 4217 currency code
`total_amount`	number	No	the total price of the reservation
`paid_amount`	number	No	the amount already paid
`balance_amount`	number	No	the remaining balance
`line_items`	PropertyLineitem[]	No	price breakdown (base price, fees, taxes, discounts)
`line_items[].type`	enum	No	base price, fee, tax, discount or deposit Values: `BASE`, `FEE`, `TAX`, `DISCOUNT`, `DEPOSIT`, `OTHER`
`line_items[].name`	string	No	the line item name, eg. Cleaning fee
`line_items[].description`	string	No	free-text description of the line item
`line_items[].amount`	number	No	the line item amount (discounts are negative)
`line_items[].is_mandatory`	boolean	No	whether the line item is mandatory
`notes`	string	No	free-text notes about the reservation
`cancelled_at`	string (date-time)	No	when the reservation was cancelled (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`web_url`	string	No	the reservation URL
`metadata`	PropertyMetadata[]	No	custom field values
`metadata[].id`	string	No	the custom field identifier
`metadata[].slug`	string	No	the custom field key
`metadata[].value`	object	No	the custom field value
`metadata[].namespace`	string	No	the scope or origin of the custom field
`metadata[].format`	enum	No	the data type of the value Values: `TEXT`, `NUMBER`, `DATE`, `BOOLEAN`, `FILE`, `TEXTAREA`, `SINGLE_SELECT`, `MULTIPLE_SELECT`, `MEASUREMENT`, `PRICE`, `YES_NO`, `CURRENCY`, `URL`
`metadata[].extra_data`	object	No	additional data about the custom field

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"
}

Status	Error	Meaning
`400`	Bad Request	The request was malformed or failed validation.
`401`	Unauthorized	The connection is likely broken; re-authorize it.
`403`	Forbidden	The connection is missing permissions or scopes.
`404`	Not Found	The requested resource does not exist.
`429`	Too Many Requests	Rate limit exceeded (see the two sources below).
`500`	Internal Server Error	An unexpected error occurred.
`501`	Not Implemented	Not 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/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Code Samples

Node.js SDK

import { UnifiedTo } from '@unified-api/typescript-sdk';

const sdk = new UnifiedTo({
    security: {
        jwt: '<YOUR_API_KEY_HERE>',
    },
});

const connectionId = '5de520f96e439b002043d8dc';

const id = '1234';

const results = await sdk.property.getPropertyReservation({ connectionId, id, 
    fields: '',
    raw: '',
 });

Node.js (axios)

const options = {
  method: 'GET',
  url: 'https://api.unified.to/property/5de520f96e439b002043d8dc/reservation/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Java

AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("GET", "https://api.unified.to/property/5de520f96e439b002043d8dc/reservation/5de520f96e439b002043d8d8?fields=&raw=")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();

Go

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

url := `https://api.unified.to/property/5de520f96e439b002043d8dc/reservation/5de520f96e439b002043d8d8?fields=&raw=

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)

Python

import requests

url = "https://api.unified.to/property/5de520f96e439b002043d8dc/reservation/5de520f96e439b002043d8d8?fields=&raw="

headers = {
    "accept": "application/json",
    "authorization": "....."
}

response = requests.get(url, headers=headers)

PHP

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unified.to/property/5de520f96e439b002043d8dc/reservation/5de520f96e439b002043d8d8?fields=&raw=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "accept: application/json",
    "authorization: ....."
  ],
]);

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.unified.to/property/5de520f96e439b002043d8dc/reservation/5de520f96e439b002043d8d8?fields=&raw=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["authorization"] = '....'

response = http.request(request)
puts response.read_body

cURL

curl --request GET \
  --url 'https://api.unified.to/property/5de520f96e439b002043d8dc/reservation/5de520f96e439b002043d8d8?fields=&raw=' \
  --header 'accept: application/json' \
  --header 'authorization: .....'

Are we missing anything? Let us know

Was this page helpful?