Skip to main content
POST
/
properties
/
search
Search Properties
curl --request POST \
  --url https://data.apartmentiq.io/apartmentiq/api/v2/properties/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "{account_id}",
  "query": "Marina"
}
'
{
  "properties": [
    {
      "id": 781245,
      "property_name": "Marina Landing",
      "city": "Austin",
      "state": "TX",
      "zip_code": "78701",
      "unit_count": 284,
      "year_built": 2019,
      "year_renovated": null,
      "property_class": "A",
      "address": "401 Riverfront Dr",
      "image_url": "https://cdn.example.com/properties/marina-landing.jpg",
      "latitude": 30.2647,
      "longitude": -97.7478
    },
    {
      "id": 781266,
      "property_name": "Marina Heights",
      "city": "Austin",
      "state": "TX",
      "zip_code": "78703",
      "unit_count": 196,
      "year_built": 2012,
      "year_renovated": 2021,
      "property_class": "B",
      "address": "88 Lakeview Ave",
      "image_url": null,
      "latitude": 30.2799,
      "longitude": -97.7696
    }
  ],
  "pagination": {
    "current_page": 1,
    "total_pages": 2,
    "total_count": 76,
    "per_page": 50
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
account_id
required

ApartmentIQ account ID used to set the request account context.

query
string
required

Search term.

page
integer
default:1

One-based page number. Values less than 1 are treated as 1.

Required range: x >= 1
per_page
integer
default:50

Rows per page. Values above 100 are capped at 100.

Required range: 1 <= x <= 100
stakeholder_entity_ids

Optional stakeholder entity IDs. Rails accepts arrays or comma-delimited strings.

Response

Property search results and pagination metadata.

Paginated property search results.

properties
object[]
required

Properties matching the search query and filters.

pagination
object
required

Pagination details for the property search results.