---
title: "Retrieve an unittype"
url: "https://docs.unified.to/property/unittype/Retrieve_an_unittype"
description: "Retrieve an unittype with Unified's Unittype API (GET /property/{connection_id}/unittype/{id}). Filter by fields and raw. Supported by 7 Unittype integrations."
date: "2026-10-29T08:41:27.988Z"
updated: "2026-10-29T08:41:27.988Z"
---
# Retrieve an unittype

Updated: October 29, 2026

 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

**fields**string array 

id

created\_at

updated\_at

listing\_id

name

description

image\_urls

unit\_count

max\_occupancy

bedrooms

beds

bathrooms

min\_nights

max\_nights

currency

start\_price\_amount

cleaning\_fee\_amount

extra\_person\_fee\_amount

amenities

metadata

raw

Fields to return

**raw**string 

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\_id**string  required 

ID of the connection

**id**string  required 

ID of the Unittype

## Returns

[PropertyUnittype](https://docs.unified.to/property/unittype/model.md)

| 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). 

```json
{
  "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`.

## Code Samples

### Node.js SDK

```javascript
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.getPropertyUnittype({ connectionId, id, 
    fields: '',
    raw: '',
 });
```

### Node.js (axios)

```javascript
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);
```

### Java

```java
AsyncHttpClient client = new DefaultAsyncHttpClient();

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

client.close();
```

### Go

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

url := `https://api.unified.to/property/5de520f96e439b002043d8dc/unittype/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

```python
import requests

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

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

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

### PHP

```php
$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unified.to/property/5de520f96e439b002043d8dc/unittype/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

```ruby
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.unified.to/property/5de520f96e439b002043d8dc/unittype/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

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