Listings
The listing object
Listings represent properties that are for sale or rent.
| Field | Type | Description |
|---|---|---|
id | string | Listing UUID. Use this as the stable machine identifier. |
private_reference | string | Organization’s internal listing reference. |
public_reference | integer | Organization-scoped numeric public reference. |
user | string | Display name of the AvaroAI user responsible for the listing. |
type | string | Property type. This is an enumerated value and can be one of: apartment, commercial_development, commercial_property, house, land_plot, land_ruin, land_project, mixed_development, or other. |
rating | string | The organization’s rating. This is an enumerated value and can be one of: excellent, fair, poor, or none. |
rental | boolean | true for a rental or lease listing; false for a sale. |
bedrooms | integer | Bedroom count. May be 0 when not applicable. |
bathrooms | integer | Bathroom count. May be 0 when not applicable. |
reception_rooms | integer | Reception-room count. May be 0 when not applicable. |
parking | array of strings | Parking options. Any of allocated, communal, covered, driveway, garage, gated, none, off_street, on_street, permit, private, rear, or residents. |
plot_size | number | Plot size in the organization’s configured measurement unit. |
covered_area | number | Covered area in the organization’s configured measurement unit. |
title | string | Public marketing title. |
line_1 | string | First address line. |
line_2 | string or null | Second address line. |
city | string | Town or city. |
region | string | Region, state, province, or county. |
post_code | string | Postal or ZIP code. |
coordinates | string or null | Latitude and longitude stored as one comma-separated string. |
price_period | string or null | The period that a rental’s published_price covers. This is an enumerated value and can be one of: night, week, or month. null for sales. |
published_price | integer | Published price in the organization’s configured currency. For rentals, this is the price per price_period. |
description | string | Public property description. |
custom_fields | array | Custom-field objects for the listing’s fields that are marked Visible, apply to the listing’s sale or rental type, and have a value. May be empty. |
photos | array | Photo objects associated with the listing. May be empty. |
created_at | string | ISO 8601 creation timestamp. |
updated_at | string | ISO 8601 timestamp of the most recent update to the listing record. It does not reliably change for photo-only additions, edits, reordering, or deletion, so compare the photos array to detect image changes. |
The custom field object
This section contains any custom fields assigned to listing records, and the values users have stored for them.
Items follow the order of the organization’s custom fields.
Fields that are not visible, that apply only to the other listing type, that have no value on the listing, or that have been deleted are excluded.
A field deleted and created again with the same label gets a new id so it can be identified separately.
| Field | Type | Description |
|---|---|---|
id | string | Custom-field UUID. It stays the same when the field’s label is edited, so use it to map fields in your integration. |
label | string | The field’s current label. |
value | string, number, boolean, or null | The listing’s value. The type depends on the field’s type. |
The photo object
Photos consist of actual property images taken at the site, as well as uploaded floor plans.
| Field | Type | Description |
|---|---|---|
id | string | Photo UUID. |
caption | string or null | Optional photo caption. |
index | integer | One-based index indicating saved display position. |
floor_plan | boolean | Whether the image represents a floor plan. |
large | string | The url to the large JPEG rendition. |
small | string | The url to the small JPEG rendition (thumbnail). |
{
"id": "01993f77-2f8c-73ce-a374-6cc73769b064",
"private_reference": "VA7485",
"public_reference": 148,
"user": "Alex Morgan",
"type": "house",
"rating": "excellent",
"rental": false,
"bedrooms": 4,
"bathrooms": 3,
"reception_rooms": 2,
"parking": [
"driveway",
"garage"
],
"plot_size": 850.5,
"covered_area": 245.75,
"title": "Four-bedroom home with a private garden",
"line_1": "24 Example Road",
"line_2": null,
"city": "London",
"region": "Greater London",
"post_code": "SW1A 1AA",
"coordinates": "51.5014, -0.1416",
"price_period": null,
"published_price": 1250000,
"description": "A well-presented family home close to local amenities.",
"custom_fields": [
{
"id": "9b0c8f9e-6a51-4d1f-9f0e-2f4b6a7c1d23",
"label": "Tenure",
"value": "Freehold"
},
{
"id": "3e5d2a10-7c4b-4b8e-a6f2-91d0c4e8b7a5",
"label": "Has garden",
"value": true
}
],
"photos": [
{
"id": "01993f77-62ae-72e3-a00f-06638d19f2cc",
"caption": "Front elevation",
"index": 1,
"floor_plan": false,
"large": "https://cdn.avaroai.com/85dd2694-3072-4e86-9665-2b9f92d425a3.jpg",
"small": "https://cdn.avaroai.com/d95ac2a8-cbce-4db8-83be-37596400869a.jpg"
}
],
"created_at": "2026-08-25T09:30:00.000000Z",
"updated_at": "2026-08-28T14:12:05.000000Z"
}
View Listings
GET/api/v1/operations/listings
This endpoint allows you to paginate through all of your active listings that have been marked as ‘Published’.
Results are ordered by listing identifier in descending order, which places the newest listings first.
Do not hotlink AvaroAI image paths or use AvaroAI as the image host for an external website. Access may be restricted if an integration repeatedly breaches the image-hosting rules or rate limit.
Query parameters
This endpoint does not support filters or custom sorting.
| Parameter | Type | Description |
|---|---|---|
page | integer | The page to retrieve. Defaults to the first page. See Pagination. |
Returns
A page of up to 20 listing objects in data, with links and meta pagination fields.
curl "https://app.avaroai.com/api/v1/operations/listings" \
--header "Authorization: Bearer YOUR_API_KEY" \
--header "Accept: application/json"
{
"data": [
{
"id": "01993f77-2f8c-73ce-a374-6cc73769b064",
"private_reference": "VA7485",
"public_reference": 148,
"user": "Alex Morgan",
"type": "house",
"rating": "excellent",
"rental": false,
"bedrooms": 4,
"bathrooms": 3,
"reception_rooms": 2,
"parking": [
"driveway",
"garage"
],
"plot_size": 850.5,
"covered_area": 245.75,
"title": "Four-bedroom home with a private garden",
"line_1": "24 Example Road",
"line_2": null,
"city": "London",
"region": "Greater London",
"post_code": "SW1A 1AA",
"coordinates": "51.5014, -0.1416",
"price_period": null,
"published_price": 1250000,
"description": "A well-presented family home close to local amenities.",
"custom_fields": [
{
"id": "9b0c8f9e-6a51-4d1f-9f0e-2f4b6a7c1d23",
"label": "Tenure",
"value": "Freehold"
}
],
"photos": [
{
"id": "01993f77-62ae-72e3-a00f-06638d19f2cc",
"caption": "Front elevation",
"index": 1,
"floor_plan": false,
"large": "https://cdn.avaroai.com/85dd2694-3072-4e86-9665-2b9f92d425a3.jpg",
"small": "https://cdn.avaroai.com/d95ac2a8-cbce-4db8-83be-37596400869a.jpg"
}
],
"created_at": "2026-08-25T09:30:00.000000Z",
"updated_at": "2026-08-28T14:12:05.000000Z"
}
],
"links": {
"first": "https://app.avaroai.com/api/v1/operations/listings?page=1",
"last": null,
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"current_page_url": "https://app.avaroai.com/api/v1/operations/listings?page=1",
"from": 1,
"path": "https://app.avaroai.com/api/v1/operations/listings",
"per_page": 20,
"to": 1
}
}
