BRbreezeway

List elements

get/property/{id}/elements

Request

  • Base URL
    https://api.breezeway.io/public/inventory/v1
  • URL
    https://api.breezeway.io/public/inventory/v1/property/{id}/elements
  • Auth
    API key in header Authorization

Path parameters

idinteger required

The internal Breezeway property ID

Query parameters

updated_sincestring date-time

ISO 8601, with or without an offset; an offset is converted to UTC, a value without one is read as UTC. Returns elements created, changed or deleted at or after this moment, including archived ones so deletions can be reconciled. Comparison is inclusive, so a record on the boundary repeats rather than going missing.

Response

OK

idinteger required

Unique Breezeway ID for the home element

home_idinteger required

Internal Breezeway home ID for the element

parent_idinteger

The parent element unique identifier, if nested

namestring required

The name of the element

type_elementstring required

The internal Breezeway code for the element type

general_notestring

A description or note for the element

secure_notestring

A description or note for the element with access restrictions

floorinteger

The floor number, if specified

orderinteger required

The in-platform sort order to display the element

created_atstring date-time required

The ISO8601 timestamp in UTC for when the element was created

updated_atstring date-time

The ISO8601 timestamp in UTC for when the element was last modified

archived_atstring date-time

The ISO8601 timestamp in UTC for when the element was removed, if applicable

Changes

No recorded changes to this operation across all 1 revision of this API.