ViewDetails

Detailed iGUIDE view resource.

attrsobject

View attributes (e.g. color scheme, autoplay).

bannerIdstring

The public ID of the banner applied to this View, if any.

Example: b_7566eb27-5682-424e-80aa-d2240e657ebb

createdAtstring

The time the View was created. Only populated when reading a single view.

Example: 2026-06-15T18:22:08.032Z

descriptionstring

The View description.

Example: Fully furnished 3-bedroom main floor

expiresAtstring

The expiration date of the View in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ).

Example: 2027-06-15T18:22:08.021Z

idstring

The View ID.

Example: v0A1XTC41HBSB1

iguide object

The iGUIDE this View belongs to.

aliasstring

attrs object

property name*any

createdAtstring

The time the iGUIDE was created. Only populated when reading a single iGUIDE.

editorsstring[]

editorsPublicstring[]

idstring

images object[]

Array [

namestring

Example: gallery_front.jpg

]

licenseestring

managerstring

previewStatusstring

primaryContactstring

primaryContactPublicstring

property object

Property an iGUIDE belongs to.

apartmentinteger

buildingClientIdstring

buildingIdstring

buildingNamestring

buildingTypestring

citystring

codestring

countrystring

housestring

idstring

noAddressboolean

provincestring

streetstring

unitstring

propertyIndustrystring

typestring

views object[]

A summary of the iGUIDE's views. An iGUIDE always has at least its default view, so this is non-empty when present. Only populated (and serialized) when reading a single iGUIDE.

Array [

bannerIdstring

The public ID of the banner applied to this View, if any.

expiresAtstring

The expiration date of the View in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ)

idstring

The View ID.

isDefaultboolean

Indicates if the View is the default View or not.

isLockedboolean

Indicates if the View is locked (its expiration date has passed).

titlestring

The View title.

]

zeroedOutAtstring

images object[]

Images attached to the View.

Array [

namestring

Example: gallery_front.jpg

]

isDefaultboolean

Indicates if the View is the default View or not.

Example: true

isLockedboolean

Indicates if the View is locked (its expiration date has passed).

Example: false

isProtectedboolean

Indicates if the View is protected (requires authorization to be viewed).

Example: true

measurementStandardstring

The measurement standard the View was drafted with.

Example: rms

titlestring

The View title.

Example: Main Floor

updatedAtstring

The time the View was last updated. Only populated when reading a single view.

Example: 2026-06-15T18:24:21.330Z

viewersstring[]

Internal user IDs allowed to access the View when it is protected.

Example: ["42"]

viewersPublicstring[]

Public user IDs allowed to access the View when it is protected.

Example: ["u_b3d44e0a-9f1e-4c7a-8b2d-1c5f8e9a0d34"]

ViewDetails

{
  "attrs": {},
  "bannerId": "b_7566eb27-5682-424e-80aa-d2240e657ebb",
  "createdAt": "2026-06-15T18:22:08.032Z",
  "description": "Fully furnished 3-bedroom main floor",
  "expiresAt": "2027-06-15T18:22:08.021Z",
  "id": "v0A1XTC41HBSB1",
  "iguide": {
    "alias": "string",
    "attrs": {},
    "createdAt": "string",
    "editors": [
      "string"
    ],
    "editorsPublic": [
      "string"
    ],
    "id": "string",
    "images": [
      {
        "name": "gallery_front.jpg"
      }
    ],
    "licensee": "string",
    "manager": "string",
    "previewStatus": "string",
    "primaryContact": "string",
    "primaryContactPublic": "string",
    "property": {
      "apartment": 0,
      "buildingClientId": "string",
      "buildingId": "string",
      "buildingName": "string",
      "buildingType": "string",
      "city": "string",
      "code": "string",
      "country": "string",
      "house": "string",
      "id": "string",
      "noAddress": true,
      "province": "string",
      "street": "string",
      "unit": "string"
    },
    "propertyIndustry": "string",
    "type": "string",
    "views": [
      {
        "bannerId": "string",
        "expiresAt": "string",
        "id": "string",
        "isDefault": true,
        "isLocked": true,
        "title": "string"
      }
    ],
    "zeroedOutAt": "string"
  },
  "images": [
    {
      "name": "gallery_front.jpg"
    }
  ],
  "isDefault": true,
  "isLocked": false,
  "isProtected": true,
  "measurementStandard": "rms",
  "title": "Main Floor",
  "updatedAt": "2026-06-15T18:24:21.330Z",
  "viewers": [
    "42"
  ],
  "viewersPublic": [
    "u_b3d44e0a-9f1e-4c7a-8b2d-1c5f8e9a0d34"
  ]
}