GET api/listing/view/{view_id}/{culture}/items/ref_number/{ref_number}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
view_id

string

Required

ref_number

string

Required

culture

string

Required

Body Parameters

None.

Response Information

Resource Description

listing
NameDescriptionTypeAdditional information
id

string

None.

ref_number

string

None.

metadata

listing_metadata

None.

dictionary

Dictionary of Object [key] and Object [value]

None.

tag_ids

Collection of string

None.

status_code

string

None.

category_code

string

None.

subcategory_code

string

None.

subcategory_other

string

None.

market_codes

Collection of string

None.

usage_codes

Collection of string

None.

description

string

None.

addendum

string

None.

availability_date

date

None.

availability_delay

integer

None.

rent_end_date

date

None.

available_area

decimal number

None.

available_area_min

decimal number

None.

available_area_unit_code

string

None.

legal_note_codes

Collection of string

None.

inclusions

string

None.

exclusions

string

None.

contract

contract

None.

price

price

None.

assessment

assessment

None.

links

links

None.

video

video

None.

virtual_tour

virtual_tour

None.

location

location

None.

building

building

None.

land

land

None.

business

business

None.

units

Collection of listing_unit

None.

rooms

Collection of listing_room

None.

attributes

Collection of listing_attribute

None.

photos

Collection of photo

None.

documents

Collection of listing_document

None.

improvements

Collection of listing_improvement

None.

expenses

Collection of listing_expense

None.

incomes

Collection of listing_income

None.

brokers

Collection of broker_sm

None.

brokers_count

integer

None.

brokers_ids

Collection of string

None.

brokers_ref_numbers

Collection of string

None.

offices

Collection of office_sm

None.

open_houses

Collection of listing_open_house

None.

custom_fields

Dictionary of string [key] and string [value]

None.

Response Formats

application/json, text/json

Sample:
{
  "id": "sample string 1",
  "ref_number": "sample string 2",
  "metadata": {
    "datasource_id": "sample string 1",
    "ver": 2,
    "hash": "sample string 3",
    "last_modify_date": "2026-01-19T09:56:34.1266384Z",
    "publish_date": "2026-01-19T09:56:34.1266384Z",
    "culture": "sample string 6"
  },
  "tag_ids": [
    "sample string 1",
    "sample string 2"
  ],
  "status_code": "sample string 3",
  "category_code": "sample string 4",
  "subcategory_code": "sample string 5",
  "subcategory_other": "sample string 6",
  "market_codes": [
    "sample string 1",
    "sample string 2"
  ],
  "usage_codes": [
    "sample string 1",
    "sample string 2"
  ],
  "description": "sample string 7",
  "addendum": "sample string 8",
  "availability_date": "2026-01-19T09:56:34.1266384Z",
  "availability_delay": 1,
  "rent_end_date": "2026-01-19T09:56:34.1266384Z",
  "available_area": 1.0,
  "available_area_min": 1.0,
  "available_area_unit_code": "sample string 9",
  "legal_note_codes": [
    "sample string 1",
    "sample string 2"
  ],
  "inclusions": "sample string 10",
  "exclusions": "sample string 11",
  "contract": {
    "start_date": "2026-01-19T09:56:34.1266384Z",
    "end_date": "2026-01-19T09:56:34.1266384Z"
  },
  "price": {
    "sell": {
      "amount": 1.0,
      "currency": "sample string 1",
      "unit_code": "sample string 2",
      "taxable": true
    },
    "lease": {
      "amount": 1.0,
      "currency": "sample string 1",
      "unit_code": "sample string 2",
      "period_code": "sample string 3",
      "taxable": true
    },
    "rent": {
      "amount": 1.0,
      "currency": "sample string 1",
      "unit_code": "sample string 2",
      "period_code": "sample string 3",
      "taxable": true
    },
    "foreclosure": true,
    "exchangeable": true
  },
  "assessment": {
    "amount": 1.0,
    "currency": "sample string 1",
    "year": 1
  },
  "links": {
    "website": "sample string 1",
    "facebook": "sample string 2",
    "twitter": "sample string 3",
    "linkedin": "sample string 4",
    "instagram": "sample string 5",
    "virtual_tour": "sample string 6",
    "youtube": "sample string 7",
    "vimeo": "sample string 8"
  },
  "video": {
    "url": "sample string 1",
    "type": "sample string 2",
    "id": "sample string 3"
  },
  "virtual_tour": {
    "url": "sample string 1",
    "type": "sample string 2",
    "id": "sample string 3"
  },
  "location": {
    "address": {
      "door": "sample string 1",
      "street_number": "sample string 2",
      "street_name": "sample string 3",
      "postal_code": "sample string 4"
    },
    "country_code": "sample string 1",
    "state": "sample string 2",
    "state_code": "sample string 3",
    "region_code": "sample string 4",
    "city": "sample string 5",
    "city_code": "sample string 6",
    "district_code": "sample string 7",
    "longitude": 1.0,
    "latitude": 1.0,
    "details": "sample string 8"
  },
  "building": {
    "category_code": "sample string 1",
    "total_levels": 1,
    "construction_year": 1,
    "assessment": {
      "amount": 1.0,
      "currency": "sample string 1",
      "year": 1
    },
    "dimension": {
      "area": 1.0,
      "area_sf": 1.0,
      "area_unit_code": "sample string 1",
      "width": 1.0,
      "length": 1.0,
      "unit_code": "sample string 2",
      "irregular": true
    }
  },
  "land": {
    "assessment": {
      "amount": 1.0,
      "currency": "sample string 1",
      "year": 1
    },
    "dimension": {
      "area": 1.0,
      "area_sf": 1.0,
      "area_unit_code": "sample string 1",
      "width": 1.0,
      "length": 1.0,
      "unit_code": "sample string 2",
      "irregular": true
    }
  },
  "business": {
    "name": "sample string 1",
    "start_year": 1,
    "is_franchise": true
  },
  "units": [
    {
      "sequence": 1,
      "category_code": "sample string 2",
      "category_other": "sample string 3",
      "details": "sample string 4",
      "inclusions": "sample string 5",
      "exclusions": "sample string 6",
      "room_count": 1,
      "bedroom_count": 1,
      "bedroom_above_ground_count": 1,
      "bedroom_under_ground_count": 1,
      "bathroom_count": 1,
      "waterroom_count": 1,
      "parking_int_count": 1,
      "parking_ext_count": 1,
      "level": 1,
      "level_category_code": "sample string 7",
      "dimension": {
        "area": 1.0,
        "area_sf": 1.0,
        "area_unit_code": "sample string 1",
        "width": 1.0,
        "length": 1.0,
        "unit_code": "sample string 2",
        "irregular": true
      }
    },
    {
      "sequence": 1,
      "category_code": "sample string 2",
      "category_other": "sample string 3",
      "details": "sample string 4",
      "inclusions": "sample string 5",
      "exclusions": "sample string 6",
      "room_count": 1,
      "bedroom_count": 1,
      "bedroom_above_ground_count": 1,
      "bedroom_under_ground_count": 1,
      "bathroom_count": 1,
      "waterroom_count": 1,
      "parking_int_count": 1,
      "parking_ext_count": 1,
      "level": 1,
      "level_category_code": "sample string 7",
      "dimension": {
        "area": 1.0,
        "area_sf": 1.0,
        "area_unit_code": "sample string 1",
        "width": 1.0,
        "length": 1.0,
        "unit_code": "sample string 2",
        "irregular": true
      }
    }
  ],
  "rooms": [
    {
      "sequence": 1,
      "unit_sequence": 2,
      "category_code": "sample string 3",
      "category_other": "sample string 4",
      "details": "sample string 5",
      "level": 1,
      "level_category_code": "sample string 6",
      "flooring_code": "sample string 7",
      "flooring_other": "sample string 8",
      "dimension": {
        "area": 1.0,
        "area_sf": 1.0,
        "area_unit_code": "sample string 1",
        "width": 1.0,
        "length": 1.0,
        "unit_code": "sample string 2",
        "irregular": true
      }
    },
    {
      "sequence": 1,
      "unit_sequence": 2,
      "category_code": "sample string 3",
      "category_other": "sample string 4",
      "details": "sample string 5",
      "level": 1,
      "level_category_code": "sample string 6",
      "flooring_code": "sample string 7",
      "flooring_other": "sample string 8",
      "dimension": {
        "area": 1.0,
        "area_sf": 1.0,
        "area_unit_code": "sample string 1",
        "width": 1.0,
        "length": 1.0,
        "unit_code": "sample string 2",
        "irregular": true
      }
    }
  ],
  "attributes": [
    {
      "code": "sample string 1",
      "values": [
        {
          "code": "sample string 1",
          "count": 1,
          "flag": true,
          "details": "sample string 2"
        },
        {
          "code": "sample string 1",
          "count": 1,
          "flag": true,
          "details": "sample string 2"
        }
      ]
    },
    {
      "code": "sample string 1",
      "values": [
        {
          "code": "sample string 1",
          "count": 1,
          "flag": true,
          "details": "sample string 2"
        },
        {
          "code": "sample string 1",
          "count": 1,
          "flag": true,
          "details": "sample string 2"
        }
      ]
    }
  ],
  "photos": [
    {
      "url": "sample string 1",
      "source_url": "sample string 2",
      "category_code": "sample string 3",
      "category_other": "sample string 4",
      "description": "sample string 5"
    },
    {
      "url": "sample string 1",
      "source_url": "sample string 2",
      "category_code": "sample string 3",
      "category_other": "sample string 4",
      "description": "sample string 5"
    }
  ],
  "documents": [
    {
      "url": "sample string 1",
      "source_url": "sample string 2",
      "category_code": "sample string 3",
      "category_other": "sample string 4",
      "description": "sample string 5",
      "content_type": "sample string 6",
      "size": 1,
      "source_last_update_date": "2026-01-19T09:56:34.1379919Z",
      "source_file_name": "sample string 7",
      "source_file_extension": "sample string 8"
    },
    {
      "url": "sample string 1",
      "source_url": "sample string 2",
      "category_code": "sample string 3",
      "category_other": "sample string 4",
      "description": "sample string 5",
      "content_type": "sample string 6",
      "size": 1,
      "source_last_update_date": "2026-01-19T09:56:34.1379919Z",
      "source_file_name": "sample string 7",
      "source_file_extension": "sample string 8"
    }
  ],
  "improvements": [
    {
      "type_code": "sample string 1",
      "type_other": "sample string 2",
      "year": 1,
      "amount": 1.0,
      "details": "sample string 3"
    },
    {
      "type_code": "sample string 1",
      "type_other": "sample string 2",
      "year": 1,
      "amount": 1.0,
      "details": "sample string 3"
    }
  ],
  "expenses": [
    {
      "type_code": "sample string 1",
      "type_other": "sample string 2",
      "amount": 1.0,
      "period_code": "sample string 3",
      "year": 1,
      "expire_year": 1,
      "details": "sample string 4"
    },
    {
      "type_code": "sample string 1",
      "type_other": "sample string 2",
      "amount": 1.0,
      "period_code": "sample string 3",
      "year": 1,
      "expire_year": 1,
      "details": "sample string 4"
    }
  ],
  "incomes": [
    {
      "type_code": "sample string 1",
      "type_other": "sample string 2",
      "amount": 1.0,
      "period_code": "sample string 3",
      "year": 1,
      "expire_year": 1,
      "details": "sample string 4"
    },
    {
      "type_code": "sample string 1",
      "type_other": "sample string 2",
      "amount": 1.0,
      "period_code": "sample string 3",
      "year": 1,
      "expire_year": 1,
      "details": "sample string 4"
    }
  ],
  "brokers": [
    {
      "id": "sample string 1",
      "ref_number": "sample string 2",
      "first_name": "sample string 3",
      "last_name": "sample string 4",
      "company_name": "sample string 5",
      "company_type": "sample string 6",
      "license": "sample string 7",
      "license_type_code": "sample string 8",
      "title": "sample string 9",
      "tag_ids": [
        "sample string 1",
        "sample string 2"
      ],
      "email": "sample string 10",
      "phones": {
        "home": "sample string 1",
        "mobile": "sample string 2",
        "office": "sample string 3",
        "office_toll_free": "sample string 4"
      },
      "photo_url": "sample string 11",
      "listings_count": 12,
      "office_id": "sample string 13",
      "office_ref_number": "sample string 14",
      "agency_id": "sample string 15",
      "agency_ref_number": "sample string 16",
      "languages": [
        "sample string 1",
        "sample string 2"
      ],
      "custom_fields": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      },
      "priority": 1,
      "priority_group_key": "sample string 17",
      "serviced_city_codes": [
        "sample string 1",
        "sample string 2"
      ],
      "serviced_region_codes": [
        "sample string 1",
        "sample string 2"
      ],
      "serviced_state_codes": [
        "sample string 1",
        "sample string 2"
      ],
      "serviced_country_codes": [
        "sample string 1",
        "sample string 2"
      ],
      "name": "sample string 4 sample string 3"
    },
    {
      "id": "sample string 1",
      "ref_number": "sample string 2",
      "first_name": "sample string 3",
      "last_name": "sample string 4",
      "company_name": "sample string 5",
      "company_type": "sample string 6",
      "license": "sample string 7",
      "license_type_code": "sample string 8",
      "title": "sample string 9",
      "tag_ids": [
        "sample string 1",
        "sample string 2"
      ],
      "email": "sample string 10",
      "phones": {
        "home": "sample string 1",
        "mobile": "sample string 2",
        "office": "sample string 3",
        "office_toll_free": "sample string 4"
      },
      "photo_url": "sample string 11",
      "listings_count": 12,
      "office_id": "sample string 13",
      "office_ref_number": "sample string 14",
      "agency_id": "sample string 15",
      "agency_ref_number": "sample string 16",
      "languages": [
        "sample string 1",
        "sample string 2"
      ],
      "custom_fields": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      },
      "priority": 1,
      "priority_group_key": "sample string 17",
      "serviced_city_codes": [
        "sample string 1",
        "sample string 2"
      ],
      "serviced_region_codes": [
        "sample string 1",
        "sample string 2"
      ],
      "serviced_state_codes": [
        "sample string 1",
        "sample string 2"
      ],
      "serviced_country_codes": [
        "sample string 1",
        "sample string 2"
      ],
      "name": "sample string 4 sample string 3"
    }
  ],
  "brokers_count": 12,
  "brokers_ids": [
    "sample string 1",
    "sample string 2"
  ],
  "brokers_ref_numbers": [
    "sample string 1",
    "sample string 2"
  ],
  "offices": [
    {
      "id": "sample string 1",
      "ref_number": "sample string 2",
      "agency_id": "sample string 3",
      "agency_ref_number": "sample string 4",
      "tag_ids": [
        "sample string 1",
        "sample string 2"
      ],
      "name": "sample string 5",
      "email": "sample string 6",
      "main_office": true,
      "location": {
        "address": {
          "door": "sample string 1",
          "street_number": "sample string 2",
          "street_name": "sample string 3",
          "postal_code": "sample string 4"
        },
        "country_code": "sample string 1",
        "state": "sample string 2",
        "state_code": "sample string 3",
        "region_code": "sample string 4",
        "city": "sample string 5",
        "city_code": "sample string 6",
        "district_code": "sample string 7",
        "longitude": 1.0,
        "latitude": 1.0
      },
      "phones": {
        "home": "sample string 1",
        "mobile": "sample string 2",
        "office": "sample string 3",
        "office_toll_free": "sample string 4"
      },
      "links": {
        "website": "sample string 1",
        "facebook": "sample string 2",
        "twitter": "sample string 3",
        "linkedin": "sample string 4",
        "instagram": "sample string 5",
        "virtual_tour": "sample string 6",
        "youtube": "sample string 7",
        "vimeo": "sample string 8"
      },
      "agency": {
        "id": "sample string 1",
        "ref_number": "sample string 2",
        "metadata": {
          "datasource_id": "sample string 1",
          "ver": 2,
          "hash": "sample string 3",
          "last_modify_date": "2026-01-19T09:56:34.1517191Z",
          "publish_date": "2026-01-19T09:56:34.1517191Z",
          "culture": "sample string 6"
        },
        "tag_ids": [
          "sample string 1",
          "sample string 2"
        ],
        "license": "sample string 3",
        "license_type_code": "sample string 4",
        "name": "sample string 5",
        "franchisor_code": "sample string 6"
      },
      "listings_count": 7,
      "brokers_count": 8,
      "priority": 1,
      "priority_group_key": "sample string 9"
    },
    {
      "id": "sample string 1",
      "ref_number": "sample string 2",
      "agency_id": "sample string 3",
      "agency_ref_number": "sample string 4",
      "tag_ids": [
        "sample string 1",
        "sample string 2"
      ],
      "name": "sample string 5",
      "email": "sample string 6",
      "main_office": true,
      "location": {
        "address": {
          "door": "sample string 1",
          "street_number": "sample string 2",
          "street_name": "sample string 3",
          "postal_code": "sample string 4"
        },
        "country_code": "sample string 1",
        "state": "sample string 2",
        "state_code": "sample string 3",
        "region_code": "sample string 4",
        "city": "sample string 5",
        "city_code": "sample string 6",
        "district_code": "sample string 7",
        "longitude": 1.0,
        "latitude": 1.0
      },
      "phones": {
        "home": "sample string 1",
        "mobile": "sample string 2",
        "office": "sample string 3",
        "office_toll_free": "sample string 4"
      },
      "links": {
        "website": "sample string 1",
        "facebook": "sample string 2",
        "twitter": "sample string 3",
        "linkedin": "sample string 4",
        "instagram": "sample string 5",
        "virtual_tour": "sample string 6",
        "youtube": "sample string 7",
        "vimeo": "sample string 8"
      },
      "agency": {
        "id": "sample string 1",
        "ref_number": "sample string 2",
        "metadata": {
          "datasource_id": "sample string 1",
          "ver": 2,
          "hash": "sample string 3",
          "last_modify_date": "2026-01-19T09:56:34.1517191Z",
          "publish_date": "2026-01-19T09:56:34.1517191Z",
          "culture": "sample string 6"
        },
        "tag_ids": [
          "sample string 1",
          "sample string 2"
        ],
        "license": "sample string 3",
        "license_type_code": "sample string 4",
        "name": "sample string 5",
        "franchisor_code": "sample string 6"
      },
      "listings_count": 7,
      "brokers_count": 8,
      "priority": 1,
      "priority_group_key": "sample string 9"
    }
  ],
  "open_houses": [
    {
      "sequence": 1,
      "start_date": "2026-01-19T09:56:34.1517191Z",
      "end_date": "2026-01-19T09:56:34.1517191Z",
      "details": "sample string 2"
    },
    {
      "sequence": 1,
      "start_date": "2026-01-19T09:56:34.1517191Z",
      "end_date": "2026-01-19T09:56:34.1517191Z",
      "details": "sample string 2"
    }
  ],
  "custom_fields": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}