List listings
aryeo_list_listingsList the property listings of your Aryeo company (address, status, price, bedrooms, delivery status, thumbnails). Filter by search text, address, listing agent, status, price/size ranges or delivery status. GET /listings.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, from 1 (default 1). Pass the previous reply's next_page. | |
| sort | No | Comma-separated sort fields; a leading - sorts descending. Default -created_at. | |
| active | No | true = only listings with an active status (coming soon, for sale/lease, pending, sold, leased). | |
| search | No | Listings with a field matching this text. | |
| status | No | Only listings with this status. | |
| address | No | Listings whose address matches, e.g. 123 Main St. | |
| include | No | Comma-separated relations to expand. Examples: list_agent, co_list_agent, images, files, videos, floor_plans, interactive_content, property_website, orders.appointments. An unknown value makes Aryeo reply with the allowed list. | |
| per_page | No | Results per page, 1-100 (Aryeo default 25). | |
| price_max | No | Maximum price. | |
| price_min | No | Minimum price. | |
| list_agent | No | Listings whose listing or co-listing agent matches, e.g. John Doe. | |
| bedrooms_max | No | Maximum bedrooms. | |
| bedrooms_min | No | Minimum bedrooms. | |
| bathrooms_max | No | Maximum bathrooms. | |
| bathrooms_min | No | Minimum bathrooms. | |
| delivery_status | No | Only listings with this media delivery status. | |
| square_feet_max | No | Maximum square feet. | |
| square_feet_min | No | Minimum square feet. |