v6
OpenAPI 3.1.02026-08-0331136162.2 KBList properties
Returns a paginated list of properties accessible to your integration.
Use this endpoint to discover available properties and their basic information. Filter by active/inactive status to find specific properties.
Access Control: You will only see properties that your API credentials have been granted access to. Contact your account manager to request access to additional properties.
Query parameters
Number of properties to return (max 500)
Number of properties to return (max 500)
Whether to return only active properties
Whether to return only active properties
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.
Optional filter to include only properties within a given organization
Optional filter to include only properties within a given organization
Response
Successful Response
Example response
{
"properties": [
{
"id": "12345",
"name": "Sunrise Apartments",
"property_type": "multi_family",
"status": "active",
"address": {
"street_address": "123 Main Street",
"city": "San Francisco",
"state": "CA",
"postal_code": "94105",
"country": "US"
},
"total_units": 250,
"external_ids": [
{
"source": "YardiVoyager",
"id_type": "property",
"external_id": "12345"
}
],
"buildings": []
}
],
"pagination": {
"next_cursor": "a3naIad30=",
"has_more": true
}
}