Sign in

v6

OpenAPI 3.1.02026-08-0331136162.2 KB
Units v2

List units for a property

Returns a paginated list of units for a specific property.

Use this endpoint to retrieve all units within a property, with support for cursor-based pagination to handle large result sets efficiently.

Access Control: You must have access to the specified property to view its units.

get/v2/properties/{property_id}/units

Path parameters

property_idstring required

The property ID

The property ID

Query parameters

limitinteger

Number of units to return (max 500)

Number of units to return (max 500)

cursorstring

Pagination cursor from previous response. Use the next_cursor value from the previous response to get the next page.

Pagination cursor from previous response. Use the next_cursor value from the previous response to get the next page.

Response

Successful Response

Example response

{
  "units": [
    {
      "building_id": "501",
      "address": {
        "street_address": "123 Main Street",
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94105",
        "country": "US"
      }
    }
  ],
  "pagination": {
    "next_cursor": "eyJpZCI6IjEyMyIsImRhdGUiOiIyMDI0LTAxLTAxVDE0OjIwOjAwWiJ9",
    "has_more": true
  }
}