Skip to main content
POST
Search Properties

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.