Retrieve an unittype
GET/property/{connection_id}/unittype/{id}
Retrieves a single PropertyUnittype by its id. Obtain id values from the corresponding list endpoint. Use fields to return only the fields you need.
Parameters
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
idstring required
ID of the Unittype
Returns
| Response field | Type | Required | Description |
|---|---|---|---|
id | string | No | unique identifier for the unit type |
created_at | string (date-time) | No | when the unit type was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | when the unit type was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
listing_id | string | No | pointer to the Property Listing this unit type belongs to |
name | string | No | the unit type (room type) name |
description | string | No | free-text description of the unit type |
image_urls | string[] | No | URLs of the unit type pictures |
unit_count | number | No | number of bookable units of this type |
max_occupancy | number | No | maximum number of guests |
bedrooms | number | No | number of bedrooms |
beds | number | No | number of beds |
bathrooms | number | No | number of bathrooms |
min_nights | number | No | minimum length of stay, in nights |
max_nights | number | No | maximum length of stay, in nights |
currency | string | No | ISO 4217 currency code |
start_price_amount | number | No | the lowest nightly price |
cleaning_fee_amount | number | No | the cleaning fee |
extra_person_fee_amount | number | No | the fee per extra guest |
amenities | string[] | No | the amenity names |
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/unittype/5de520f96e439b002043d8d8',
headers: {
authorization: 'bearer .....'
},
params: {
fields: '',
raw: '',
}
};
const results = await axios.request(options); Are we missing anything? Let us know
Was this page helpful?