Units

Rentable spaces within a property. List and retrieve, plus async write-back to create a unit.

Writing back to the PMS. Creating a unit is an async write-back: POST returns an Operation immediately and the change is applied to the source PMS in the background. See the Operations page for the full submit → poll → apply flow.

get/v1/units

List units

Query parameters

limit integer — Page size, 1–100.
offset integer — Zero-based record offset.
include_deleted boolean — Include soft-deleted records.
updated_after string — Return records with updated_at >= this ISO 8601 datetime.
created_after string — Return records with created_at >= this ISO 8601 datetime.
created_before string — Return records with created_at <= this ISO 8601 datetime.
x_id string — External PMS identifier (exact match). Comma-separated list matches ANY (OR).
integration_id string — Integration UUID (exact match). Comma-separated list of UUIDs matches ANY (OR).
order-by string
property_id string — Exact match; comma-separated list matches ANY (OR).
status string — Exact match; comma-separated list matches ANY (OR).
type string — Exact match; comma-separated list matches ANY (OR).
unit_number string — Exact match; comma-separated list matches ANY (OR).
building string — Exact match; comma-separated list matches ANY (OR).
bedrooms_gte number
bedrooms_lte number
bathrooms_gte number
bathrooms_lte number

Response · 200

Page of units

Field

Type

Description

meta*

object

Field	Type	Description
limit*	integer
offset*	integer
hasMore*	boolean

results*

array<object>

Field

Type

Description

id*

string

x_id*

string

organization_id*

string (uuid)

integration_id*

string (uuid)

property_id

string | null

name

string | null

unit_number

string | null

type

string | null

status

string | null

floor

string | null

building

string | null

bedrooms

number | null

bathrooms

number | null

square_feet

number | null

market_rent

object | null

Field	Type	Description
amount*	integer	Integer minor units (e.g., cents).
currency*	string	ISO 4217 currency code.

floor_plan_name

string | null

floor_plan_id

string | null

address

object | null

description

string | null

move_in_date

string (date) | null

move_out_date

string (date) | null

available_date

string (date) | null

media

array<object> | null

custom_data*

object

created_at*

string (date-time)

updated_at*

string (date-time)

deleted_at

string (date-time) | null

ps_synced_at

string (date-time) | null

Errors

400 — Validation error
401 — Missing or invalid API key
429 — Rate limit exceeded

get/v1/units/{id}

Retrieve a unit

Path & headers

id · path · required

Query parameters

include_deleted boolean — Include soft-deleted records.

Response · 200

The unit

Field

Type

Description

id*

string

x_id*

string

organization_id*

string (uuid)

integration_id*

string (uuid)

property_id

string | null

name

string | null

unit_number

string | null

type

string | null

status

string | null

floor

string | null

building

string | null

bedrooms

number | null

bathrooms

number | null

square_feet

number | null

market_rent

object | null

Field	Type	Description
amount*	integer	Integer minor units (e.g., cents).
currency*	string	ISO 4217 currency code.

floor_plan_name

string | null

floor_plan_id

string | null

address

object | null

description

string | null

move_in_date

string (date) | null

move_out_date

string (date) | null

available_date

string (date) | null

media

array<object> | null

custom_data*

object

created_at*

string (date-time)

updated_at*

string (date-time)

deleted_at

string (date-time) | null

ps_synced_at

string (date-time) | null

Errors

400 — Validation error
401 — Missing or invalid API key
404 — Resource not found
429 — Rate limit exceeded

post/v1/units

Create a unit (async write-back)

Path & headers

Idempotency-Key · header · required

Request body (required)

Field	Type	Description
unit_number*	string
bedrooms	number
bathrooms	number
square_feet	number
max_occupants	integer
max_pets	integer
note	string
unit_gender_id	string

Response · 202

Write operation queued

Field

Type

Description

id*

string

object*

string

type*

string

status*

string

source

object

Field	Type	Description
state	string \| null
applied_at	string (date-time) \| null

reconcile

object

Field	Type	Description
state	string \| null
attempts	integer \| null
next_attempt_at	string (date-time) \| null
last_error	string \| null

resource

object

Field	Type	Description
type	string \| null
id	string \| null
x_id	string \| null

result

object | null

idempotency_key

string | null

created_at*

string (date-time)

Errors

400 — Validation error
401 — Missing or invalid API key
403 — Insufficient permissions
404 — Resource not found
409 — Duplicate idempotency key with different payload
422 — Semantic validation error
429 — Rate limit exceeded

Example

POST /v1/units

{
  "unit_number": "1042",
  "bedrooms": 2,
  "bathrooms": 2,
  "square_feet": 1080,
  "max_occupants": 4,
  "note": "South-facing, renovated 2025."
}

See the Operations page for the async write-back flow, or the Common Data Model for the full entity shapes.

Units

Query parameters

Response · 200

Errors

Path & headers

Query parameters

Response · 200

Errors

Path & headers

Request body (required)

Response · 202

Errors

Example

Next