GET api/broker/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

broker
NameDescriptionTypeAdditional information
id

string

None.

ref_number

string

None.

license

string

None.

license_type_code

string

None.

title

string

None.

metadata

broker_metadata

None.

dictionary

Dictionary of Object [key] and Object [value]

None.

tag_ids

Collection of string

None.

first_name

string

None.

last_name

string

None.

company_name

string

None.

company_type

string

None.

email

string

None.

phones

phones

None.

photo

photo

None.

links

links

None.

video

video

None.

office

office_sm

None.

listings_count

integer

None.

description

string

None.

languages

Collection of string

None.

experience_start_date

date

None.

rating_global

integer

None.

protection_codes

Collection of string

None.

reviews

Collection of Review

None.

trainings

Collection of Training

None.

custom_fields

Dictionary of string [key] and string [value]

None.

serviced_city_codes

Collection of string

None.

serviced_region_codes

Collection of string

None.

serviced_state_codes

Collection of string

None.

serviced_country_codes

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "id": "sample string 1",
  "ref_number": "sample string 2",
  "license": "sample string 3",
  "license_type_code": "sample string 4",
  "title": "sample string 5",
  "metadata": {
    "datasource_id": "sample string 1",
    "ver": 2,
    "hash": "sample string 3",
    "last_modify_date": "2026-01-16T17:56:21.2684002Z",
    "publish_date": "2026-01-16T17:56:21.2684002Z",
    "culture": "sample string 6"
  },
  "tag_ids": [
    "sample string 1",
    "sample string 2"
  ],
  "first_name": "sample string 6",
  "last_name": "sample string 7",
  "company_name": "sample string 8",
  "company_type": "sample string 9",
  "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 1",
    "source_url": "sample string 2",
    "category_code": "sample string 3",
    "category_other": "sample string 4",
    "description": "sample string 5"
  },
  "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"
  },
  "office": {
    "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-16T17:56:21.2996444Z",
        "publish_date": "2026-01-16T17:56:21.2996444Z",
        "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"
  },
  "listings_count": 11,
  "description": "sample string 12",
  "languages": [
    "sample string 1",
    "sample string 2"
  ],
  "experience_start_date": "2026-01-16T17:56:21.2996444Z",
  "rating_global": 1,
  "protection_codes": [
    "sample string 1",
    "sample string 2"
  ],
  "reviews": [
    {
      "date": "2026-01-16T17:56:21.2996444Z",
      "name": "sample string 1",
      "comments": "sample string 2"
    },
    {
      "date": "2026-01-16T17:56:21.2996444Z",
      "name": "sample string 1",
      "comments": "sample string 2"
    }
  ],
  "trainings": [
    {
      "date": "2026-01-16T17:56:21.2996444Z",
      "title": "sample string 1",
      "lang": "sample string 2"
    },
    {
      "date": "2026-01-16T17:56:21.2996444Z",
      "title": "sample string 1",
      "lang": "sample string 2"
    }
  ],
  "custom_fields": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "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"
  ]
}