GET api/office/view/{view_id}/{culture}/items/ref_number/{ref_number}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| view_id | string |
Required |
|
| ref_number | string |
Required |
|
| culture | string |
Required |
Body Parameters
None.
Response Information
Resource Description
office| Name | Description | Type | Additional information |
|---|---|---|---|
| id | string |
None. |
|
| ref_number | string |
None. |
|
| metadata | office_metadata |
None. |
|
| dictionary | Dictionary of Object [key] and Object [value] |
None. |
|
| tag_ids | Collection of string |
None. |
|
| name | string |
None. |
|
| string |
None. |
||
| main_office | boolean |
None. |
|
| location | location |
None. |
|
| phones | phones |
None. |
|
| links | links |
None. |
|
| agency | agency |
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-17T08:38:42.6673168Z",
"publish_date": "2026-01-17T08:38:42.6673168Z",
"culture": "sample string 6"
},
"tag_ids": [
"sample string 1",
"sample string 2"
],
"name": "sample string 3",
"email": "sample string 4",
"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,
"details": "sample string 8"
},
"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-17T08:38:42.6784089Z",
"publish_date": "2026-01-17T08:38:42.6784089Z",
"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",
"main_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"
},
"listings_count": 7,
"brokers_count": 8,
"priority": 1,
"priority_group_key": "sample string 9"
}
}
}