> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.propexo.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.propexo.com/_mcp/server.

# Get a unit detail by ID.

GET https://api.propexo.com/v1/units/details/{unit_detail_id}

Note: "Unit Details" are not units themselves, but rather details regarding application/listing information on a unit. This is a separate concept from generic units data, and is required to be enabled as its own model. It is uncommon for customers to require this data. Please contact support with questions

Reference: https://docs.propexo.com/api-reference/pms-generic-ap-is/units/get-a-unit-detail-by-id

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Servers

- `https://api.propexo.com` (Production, default)
- `https://api.sandbox.propexo.com` (Sandbox)

## Request

### Path parameters

- `unit_detail_id` (string, required) — The ID of the resource.

### Query parameters

- `order-by` (string, optional, default: created_at:desc) — Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc
- `updated_at_gte` (string, optional, nullable) — Filter to records updated at or after this datetime. Format: ISO 8601 (e.g. 2026-01-01T00:00:00Z)
- `updated_at_lte` (string, optional, nullable) — Filter to records updated at or before this datetime. Format: ISO 8601 (e.g. 2026-12-31T23:59:59Z)
- `last_seen_gte` (string, optional, nullable) — Filter to records whose last_seen date is on or after this datetime. Format: ISO 8601 (e.g. 2026-01-01T00:00:00Z)
- `last_seen_lte` (string, optional, nullable) — Filter to records whose last_seen date is on or before this datetime. Format: ISO 8601 (e.g. 2026-12-31T23:59:59Z)
- `offset` (integer, optional, nullable, default: 0) — Can be used for paginating results
- `limit` (integer, optional, nullable, default: 100) — A number between 1 and 250 to determine the number of results to return in a single query

## Response

### 200

Successful response

- `meta` (ResponseMeta, required)
- `results` (V1UnitsDetailsUnitDetailIdGetOutputResults, required)

## Errors

### 400 Bad Request Error

Bad Request

- `error` (ErrorResponseError, required)

## Types

### ResponseMeta

- `orderBy` (list of ResponseMetaOrderByItems, required)
- `offset` (integer, optional) — The offset of the first result
- `limit` (integer, optional) — The number of results to return
- `hasMore` (boolean, optional, nullable) — Whether there are more results
- `total` (integer, optional) — The total number of results

### V1UnitsDetailsUnitDetailIdGetOutputResults

- `id` (string, required) — The Propexo unique identifier for the unit
- `created_at` (string, required) — The date record first entered Propexo
- `updated_at` (string, required) — The date record was last updated in Propexo
- `last_seen` (string, required, nullable) — The date the record was last seen from the PMS
- `x_id` (string, required) — The external ID from the integration vendor
- `x_property_id` (string, required) — The external ID of the property from the integration vendor
- `x_location_id` (string, required, nullable) — The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations.
- `x_building_id` (string, required, nullable) — The external ID of the building (not necessarily the property) from the integration vendor
- `x_floor_plan_id` (string, required, nullable) — The external ID of the floor plan from the integration vendor
- `building_number` (string, required, nullable) — The building number associated with the unit
- `make_ready_date` (string, required, nullable) — The make ready date of the unit
- `made_ready_date` (string, required, nullable) — The made ready date of the unit
- `reserved_until_date` (string, required, nullable) — The date the unit is reserved until
- `floor_plan_market_rent_in_cents` (double, required, nullable) — The market rent cost of the floor plan, in cents
- `unit_market_rent_in_cents` (double, required, nullable) — The market rent cost of the unit, in cents
- `base_rent_in_cents` (double, required, nullable) — The base rent cost of the unit, in cents
- `unit_number` (string, required, nullable) — The unit number
- `description` (string, required, nullable) — Description of the unit
- `floor_plan_name` (string, required, nullable) — The floor plan name associated with the unit
- `accessible_hearing` (boolean, required, nullable) — Whether or not the unit is accessible for the hearing impaired
- `accessible_mobility` (boolean, required, nullable) — Whether or not the unit is accessible for the mobility impaired
- `accessible_vision` (boolean, required, nullable) — Whether or not the unit is accessible for the vision impaired
- `is_vacant` (boolean, required, nullable) — Whether the unit is vacant
- `is_available` (boolean, required, nullable) — Whether the unit is available
- `is_reserved` (boolean, required, nullable) — Whether the unit is reserved
- `available_date` (string, required, nullable) — The date that the unit becomes available
- `notes` (string, required, nullable) — Notes associated with the unit
- `gross_square_feet` (integer, required) — The gross square footage of the unit
- `rentable_square_feet` (integer, required) — The rentable square footage of the unit
- `city` (string, required, nullable) — The city associated with the unit
- `country` (string, required, nullable) — The country associated with the unit
- `state` (string, required, nullable) — The state associated with the unit
- `address_1` (string, required, nullable) — The first address line associated with the unit
- `address_2` (string, required, nullable) — The second address line associated with the unit
- `zip` (string, required, nullable) — The zip code associated with the unit
- `maximum_potential_lease_term` (string, required, nullable) — The maximum potential lease term of the unit
- `minimum_potential_lease_term` (string, required, nullable) — The minimum potential lease term of the unit
- `integration_id` (string, required) — The Propexo unique identifier for the integration
- `integration_vendor` (enum, required) — The property management system of record
  - Allowed values: `APPFOLIO`, `BUILDIUM`, `ENTRATA`, `MRI`, `PROPERTYWARE`, `PROPERTYWARE_REST`, `REALPAGE`, `REALPAGE_RPX`, `RENTMANAGER`, `RENTVINE`, `RESMAN`, `YARDI`, `YARDI_REST`
- `property_id` (string, required) — The Propexo unique identifier for the property

### ErrorResponseError

- `code` (string, required)
- `message` (string, required)
- `details` (map from string to any, optional)

### ResponseMetaOrderByItems

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "meta": {
    "orderBy": [
      {}
    ],
    "offset": 0,
    "limit": 100,
    "hasMore": true,
    "total": 1000
  },
  "results": {
    "id": "unitdetail-9f8b7c6d-1234-4e56-8a9b-0c1d2e3f4a5b",
    "created_at": "2023-11-15T09:30:00Z",
    "updated_at": "2024-05-20T16:45:00Z",
    "last_seen": "2024-05-19T12:00:00Z",
    "x_id": "ext-unit-789456123",
    "x_property_id": "ext-prop-456123789",
    "x_location_id": null,
    "x_building_id": "ext-building-321654987",
    "x_floor_plan_id": "ext-floorplan-654987321",
    "building_number": "Bldg 12",
    "make_ready_date": "2024-05-01",
    "made_ready_date": "2024-05-05",
    "reserved_until_date": "2024-06-15",
    "floor_plan_market_rent_in_cents": 125000,
    "unit_market_rent_in_cents": 130000,
    "base_rent_in_cents": 120000,
    "unit_number": "12A",
    "description": "Spacious 2-bedroom unit with balcony and city views.",
    "floor_plan_name": "Two Bedroom Deluxe",
    "accessible_hearing": false,
    "accessible_mobility": true,
    "accessible_vision": false,
    "is_vacant": false,
    "is_available": true,
    "is_reserved": false,
    "available_date": "2024-06-01",
    "notes": "Unit recently renovated with new appliances and flooring.",
    "gross_square_feet": 1100,
    "rentable_square_feet": 1050,
    "city": "Austin",
    "country": "USA",
    "state": "TX",
    "address_1": "1234 Elm Street",
    "address_2": "Unit 12A",
    "zip": "78701",
    "maximum_potential_lease_term": "24 months",
    "minimum_potential_lease_term": "6 months",
    "integration_id": "integration-abc123xyz",
    "integration_vendor": "APPFOLIO",
    "property_id": "property-789xyz456"
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.propexo.com/v1/units/details/unit_detail_id"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://api.propexo.com/v1/units/details/unit_detail_id';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://api.propexo.com/v1/units/details/unit_detail_id"

	payload := strings.NewReader("{}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

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

url = URI("https://api.propexo.com/v1/units/details/unit_detail_id")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.propexo.com/v1/units/details/unit_detail_id")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.propexo.com/v1/units/details/unit_detail_id', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.propexo.com/v1/units/details/unit_detail_id");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.propexo.com/v1/units/details/unit_detail_id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```