SightMap® Logo
API docs by Redocly

SightMap® REST API (v1.20240909)

Download OpenAPI specification:Download

URL: https://developers.sightmap.com License: Engrain Terms of Service

Introduction

The SightMap® API uses standard HTTP verbs to communicate and HTTP status codes to indicate status and errors. All responses come in standard JSON. The SightMap API is served over HTTPS to ensure data privacy; HTTP is not supported.

Versioning

Versions are communicated as VERSION.RELEASE-DATE, where VERSION denotes the version number of the API and prefixed to all API request paths, such as /v1/assets. RELEASE-DATE denotes backwards-compatible changes to the API.

When any non-backwards compatible additions must be made to the API, the version number will be incremented.

Backwards-compatible changes

We consider the following changes to be backwards-compatible:

  • Adding new API resources.
  • Adding new optional request parameters to existing API methods.
  • Adding new properties to existing API responses.
  • Changing the order of properties in existing API responses.
  • Changing the length or format of object IDs or other opaque strings.
  • You can safely assume object IDs we generate will never exceed 255 characters, but you should be able to handle IDs of up to that length. If for example you’re using MySQL, you should store IDs in a VARCHAR(255) COLLATE utf8_bin column (the COLLATE configuration ensures case-sensitivity in lookups).

Authentication

For requests which require Authentication, an API Key can be provided by either the api-key query parameter or API-Key header. We recommend the header over the query parameter as it avoids your API key from being stored in browser history and most server logs. If neither query parameter or header is provided, a 401 status code is returned with the following JSON:

{
  "message": "No API key found in request"
}

If your API key cannot be validated, a 403 status code is returned with the following JSON:

{
  "message": "Invalid authentication credentials"
}

API Key

An API key sent via the API-Key header.

curl -i -H "API-Key: 12345" https://api.sightmap.com/v1/assets
Security Scheme Type: API Key
Header parameter name: API-Key

Experimental features

We provide new API features via experimental flags. This allows users to opt-in for new functionality and provide feedback prior to a feature becoming generally available (GA). We believe in stability without stagnation. This ability allows our team to build and ship best-in-class APIs faster while upholding backwards-compatibility on GA features.

Experimental features are subject to change while undergoing development and feedback. Therefore, they are exempt from any backwards-compatibility guarantees until they reach GA. We do not expect nor recommend using experimental features in production environments unless a partnership has been established with our teams working closely together.

Flags are provided via the Experimental-Flags header. A comma-separated list is expected in order to pass multiple flags on a single request.

curl -i https://api.sightmap.com/v1/assets \
  -H "API-Key: 12345" \
  -H "Experimental-Flags: flag-1,flag-2"

Errors

The SightMap API uses standard HTTP status codes to indicate the success or failure of the API request. The body of the response will be JSON in the following format:

{
  "message": "Not found"
}

Accounts

List accounts

Returns a list of accounts.

Authorizations:
API Key
query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

Responses

Response samples

Content type
application/json
{
  • "paging": {
    • "per_page": 100,
    • "current_page": 1,
    • "prev_url": null,
    • "next_url": null
    },
  • "data": [
    • {
      }
    ]
}

View an account

Returns a specific account.

Authorizations:
API Key
path Parameters
account
required
string <id> <= 255 characters

An account ID.

Responses

Response samples

Content type
application/json
{
  • "id": "95",
  • "name": "Engrain",
  • "created_at": "2017-09-11T17:09:18+00:00",
  • "updated_at": "2017-09-11T17:09:18+00:00"
}

Embeds

List embeds

Returns a list of embeds for an account.

Requires sightmap.embeds.read permission.

NOTICE: This resource is experimental and requires the embed-resource experimental flag.

Authorizations:
API Key
path Parameters
account
required
string <id> <= 255 characters

An account ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

asset
string <id> <= 255 characters

An asset ID to filter the list on.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the embed-resource experimental flag.

Responses

Response samples

Content type
application/json
{
  • "paging": {
    • "per_page": 100,
    • "current_page": 1,
    • "prev_url": null,
    • "next_url": null
    },
  • "data": [
    • {
      }
    ]
}

View an embed

Returns a specific embed.

Requires sightmap.embeds.read permission.

NOTICE: This resource is experimental and requires the embed-resource experimental flag.

Authorizations:
API Key
path Parameters
account
required
string <id> <= 255 characters

An account ID.

embed
required
string <id> <= 255 characters

An embed ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the embed-resource experimental flag.

Responses

Response samples

Content type
application/json
{
  • "id": "5587",
  • "account_id": "95",
  • "name": "The Lofts at New Main",
  • "url": "https://sightmap.com/embed/960p78rdw7n",
  • "sightmaps": [
    • {
      }
    ],
  • "tags": [
    • "primary",
    • "full-campus"
    ],
  • "created_at": "2020-10-30T15:16:35+00:00",
  • "updated_at": "2020-11-04T23:45:31+00:00"
}

Assets

List assets

Returns a list of allowed assets on an account.

NOTICE: This resource is experimental and requires the accounts-assets experimental flag.

path Parameters
account
required
string <id> <= 255 characters

An account ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

asset
string <id> <= 255 characters

An asset ID to filter the list on.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the accounts-assets experimental flag.

Responses

Response samples

Content type
application/json
{
  • "paging": {
    • "per_page": 100,
    • "current_page": 1,
    • "prev_url": null,
    • "next_url": null
    },
  • "data": [
    • {
      }
    ]
}

Assign assets

Assign one or more assets to an account.

Requires sightmap.accounts.update-assets permission.

NOTICE: This resource is experimental and requires the accounts-assets experimental flag.

Authorizations:
API Key
path Parameters
account
required
string <id> <= 255 characters

An account ID.

Request Body schema: application/json
required
required
Array of objects
Array
account_id
required
string <id> <= 255 characters
asset_id
required
string <id> <= 255 characters

The asset assigned on the account.

Responses

Request samples

Content type
application/json
{
  • "data": [
    • {
      },
    • {
      },
    • {
      }
    ]
}

Response samples

Content type
application/json
{
  • "message": "No API key found in request"
}

Unassign assets

Unassign one or more assets from an account.

Requires sightmap.accounts.update-assets permission.

NOTICE: This resource is experimental and requires the accounts-assets experimental flag.

WARNING: When an asset is unassigned from an account, any embeds or other related data may be deleted and cannot be undone.

Authorizations:
API Key
path Parameters
account
required
string <id> <= 255 characters

An account ID.

Request Body schema: application/json
required
required
Array of objects
Array
account_id
required
string <id> <= 255 characters
asset_id
required
string <id> <= 255 characters

The asset assigned on the account.

Responses

Request samples

Content type
application/json
{
  • "data": [
    • {
      },
    • {
      }
    ]
}

Response samples

Content type
application/json
{
  • "message": "No API key found in request"
}

Assets

List assets

Returns a list of allowed assets.

Authorizations:
API Key
query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

Responses

Response samples

Content type
application/json
{
  • "paging": {
    • "per_page": 100,
    • "current_page": 1,
    • "prev_url": null,
    • "next_url": null
    },
  • "data": [
    • {
      }
    ]
}

Create an asset

Requires sightmap.assets.create permission

Authorizations:
API Key
Request Body schema: application/json
required
market
required
string
Enum: "affordable_housing" "agriculture" "airplane" "airport" "build_to_rent" "camping" "cemetery" "condos" "coworking" "cruise_ship" "cultural" "data_center" "demo" "education" "entertainment" "gallery_museum" "geography" "government" "harbor_marina" "healthcare" "hospitality" "industrial" "infrastructure" "land" "logistics" "manufactured_housing" "master_planned" "military_housing" "mixed_use" "multifamily" "office" "oil_and_gas" "other" "parking" "rentable_items" "resort" "retail" "salon" "self_storage" "senior_living" "single_family" "spa" "stadium_arena" "student" "theme_park" "transit"
name
required
string <= 255 characters
display_name
required
string <= 255 characters
description
string or null <= 255 characters
address_line1
required
string <= 63 characters
address_line2
string or null <= 63 characters
address_city
required
string <= 63 characters
address_state
required
string = 2 characters

Two letter abbreviated state or province.

address_country
required
string = 3 characters

An ISO 3166-1 alpha-3 country code.

address_postal_code
required
string <= 15 characters
address_latitude
number or null <float> [ -90 .. 90 ]
address_longitude
number or null <float> [ -180 .. 180 ]

Responses

Request samples

Content type
application/json
{
  • "market": "multifamily",
  • "name": "The Lofts at New Main",
  • "display_name": "The Lofts at New Main",
  • "description": null,
  • "address_line1": "100 New Main St",
  • "address_line2": null,
  • "address_city": "Cleveland",
  • "address_state": "OH",
  • "address_country": "USA",
  • "address_postal_code": "91801",
  • "address_latitude": 41.433243,
  • "address_longitude": -81.3941872
}

Response samples

Content type
application/json
{
  • "id": "1323",
  • "uuid": "d5779fbb-43fe-4d54-b642-266ce815a3f3",
  • "market": "multifamily",
  • "name": "The Lofts at New Main",
  • "display_name": "The Lofts at New Main",
  • "description": null,
  • "unit_count": 138,
  • "address_line1": "100 New Main St",
  • "address_line2": null,
  • "address_city": "Cleveland",
  • "address_state": "OH",
  • "address_country": "USA",
  • "address_postal_code": "91801",
  • "address_latitude": 41.433243,
  • "address_longitude": -81.3941872,
  • "created_at": "2017-09-11T17:08:59+00:00",
  • "updated_at": "2019-10-10T04:25:58+00:00"
}

View an asset

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

Responses

Response samples

Content type
application/json
{
  • "id": "1323",
  • "uuid": "d5779fbb-43fe-4d54-b642-266ce815a3f3",
  • "market": "multifamily",
  • "name": "The Lofts at New Main",
  • "display_name": "The Lofts at New Main",
  • "description": null,
  • "unit_count": 138,
  • "address_line1": "100 New Main St",
  • "address_line2": null,
  • "address_city": "Cleveland",
  • "address_state": "OH",
  • "address_country": "USA",
  • "address_postal_code": "91801",
  • "address_latitude": 41.433243,
  • "address_longitude": -81.3941872,
  • "created_at": "2017-09-11T17:08:59+00:00",
  • "updated_at": "2019-10-10T04:25:58+00:00"
}

Update an asset

Requires sightmap.assets.update permission

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

Request Body schema: application/json
required
id
required
string <id> <= 255 characters
market
string
Enum: "affordable_housing" "agriculture" "airplane" "airport" "build_to_rent" "camping" "cemetery" "condos" "coworking" "cruise_ship" "cultural" "data_center" "demo" "education" "entertainment" "gallery_museum" "geography" "government" "harbor_marina" "healthcare" "hospitality" "industrial" "infrastructure" "land" "logistics" "manufactured_housing" "master_planned" "military_housing" "mixed_use" "multifamily" "office" "oil_and_gas" "other" "parking" "rentable_items" "resort" "retail" "salon" "self_storage" "senior_living" "single_family" "spa" "stadium_arena" "student" "theme_park" "transit"
name
string <= 255 characters
display_name
string <= 255 characters
description
string or null <= 255 characters
address_line1
string <= 63 characters
address_line2
string or null <= 63 characters
address_city
string <= 63 characters
address_state
string = 2 characters

Two letter abbreviated state or province.

address_country
string = 3 characters

An ISO 3166-1 alpha-3 country code.

address_postal_code
string <= 15 characters
address_latitude
number or null <float> [ -90 .. 90 ]
address_longitude
number or null <float> [ -180 .. 180 ]

Responses

Request samples

Content type
application/json
{
  • "id": "1323",
  • "market": "multifamily",
  • "name": "The Lofts at New Main",
  • "display_name": "The Lofts at New Main",
  • "address_line1": "100 New Main St",
  • "address_city": "Cleveland",
  • "address_state": "OH",
  • "address_country": "USA",
  • "address_postal_code": "91801",
  • "address_latitude": 41.433243,
  • "address_longitude": -81.3941872
}

Response samples

Content type
application/json
{
  • "id": "1323",
  • "uuid": "d5779fbb-43fe-4d54-b642-266ce815a3f3",
  • "market": "multifamily",
  • "name": "The Lofts at New Main",
  • "display_name": "The Lofts at New Main",
  • "description": null,
  • "unit_count": 138,
  • "address_line1": "100 New Main St",
  • "address_line2": null,
  • "address_city": "Cleveland",
  • "address_state": "OH",
  • "address_country": "USA",
  • "address_postal_code": "91801",
  • "address_latitude": 41.433243,
  • "address_longitude": -81.3941872,
  • "created_at": "2017-09-11T17:08:59+00:00",
  • "updated_at": "2019-10-10T04:25:58+00:00"
}

Units

List units

Returns a list of units for an asset.

Requires sightmap.units.read permission.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

unit-number
string <= 255 characters

A unit number to filter the list on.

Responses

Response samples

Content type
application/json
{
  • "paging": {
    • "per_page": 100,
    • "current_page": 1,
    • "prev_url": null,
    • "next_url": null
    },
  • "data": [
    • {
      }
    ]
}

Create a unit

Create a unit for an asset.

Requires sightmap.units.create permission.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

Request Body schema:
required
asset_id
required
string <id> <= 255 characters

The asset the unit belongs to.

building_id
required
string <id> <= 255 characters

The building the unit is in.

floor_id
required
string <id> <= 255 characters

The floor the unit is on.

floor_plan_id
required
string <id> <= 255 characters

The floor plan of the unit.

unit_number
required
string <= 255 characters

The unit number.

area
required
integer <int32> >= 0

The area of the unit represented as square footage or square meters.

is_affordable_housing_unit
boolean
Default: false

Determines if the unit is an affordable housing unit.

Responses

Request samples

Content type
{
  • "asset_id": "1323",
  • "building_id": "8265",
  • "floor_id": "4730",
  • "floor_plan_id": "14641",
  • "unit_number": "E13",
  • "area": 700,
  • "is_affordable_housing_unit": true
}

Response samples

Content type
application/json
{
  • "id": "258670",
  • "asset_id": "1323",
  • "building_id": "8265",
  • "floor_id": "4730",
  • "floor_plan_id": "14641",
  • "map_id": "258670",
  • "unit_number": "E13",
  • "area": 700,
  • "is_affordable_housing_unit": false,
  • "view_image_url": null,
  • "secondary_view_image_url": null,
  • "created_at": "2017-09-11T17:09:18+00:00",
  • "updated_at": "2018-01-20T03:44:39+00:00"
}

View a unit

Returns a specific unit.

Requires sightmap.units.read permission.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

unit
required
string <id> <= 255 characters

A unit ID.

Responses

Response samples

Content type
application/json
{
  • "id": "258670",
  • "asset_id": "1323",
  • "building_id": "8265",
  • "floor_id": "4730",
  • "floor_plan_id": "14641",
  • "map_id": "258670",
  • "unit_number": "E13",
  • "area": 700,
  • "is_affordable_housing_unit": false,
  • "view_image_url": null,
  • "secondary_view_image_url": null,
  • "created_at": "2017-09-11T17:09:18+00:00",
  • "updated_at": "2018-01-20T03:44:39+00:00"
}

Update a unit

Requires sightmap.units.update permission.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

unit
required
string <id> <= 255 characters

A unit ID.

Request Body schema:
required
id
required
string <id> <= 255 characters
asset_id
required
string <id> <= 255 characters

The asset the unit belongs to.

building_id
string <id> <= 255 characters

The building the unit is in.

floor_id
string <id> <= 255 characters

The floor the unit is on.

floor_plan_id
string <id> <= 255 characters

The floor plan of the unit.

unit_number
string <= 255 characters

The unit number.

area
integer <int32> >= 0

The area of the unit represented as square footage or square meters.

is_affordable_housing_unit
boolean
Default: false

Determines if the unit is an affordable housing unit.

view_image
string
Value: "delete"

Delete the primary view image of the unit.

secondary_view_image
string
Value: "delete"

Delete the secondary view image of the unit.

Responses

Request samples

Content type
{
  • "id": "258670",
  • "asset_id": "1323",
  • "building_id": "8265",
  • "floor_id": "4730",
  • "floor_plan_id": "14641",
  • "map_id": "258670",
  • "unit_number": "E13",
  • "area": 700,
  • "is_affordable_housing_unit": true
}

Response samples

Content type
application/json
{
  • "id": "258670",
  • "asset_id": "1323",
  • "building_id": "8265",
  • "floor_id": "4730",
  • "floor_plan_id": "14641",
  • "map_id": "258670",
  • "unit_number": "E13",
  • "area": 700,
  • "is_affordable_housing_unit": false,
  • "view_image_url": null,
  • "secondary_view_image_url": null,
  • "created_at": "2017-09-11T17:09:18+00:00",
  • "updated_at": "2018-01-20T03:44:39+00:00"
}

Delete a unit

Requires sightmap.units.delete permission.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

unit
required
string <id> <= 255 characters

A unit ID.

Responses

Response samples

Content type
application/json
{
  • "id": "258670",
  • "asset_id": "1323",
  • "building_id": "8265",
  • "floor_id": "4730",
  • "floor_plan_id": "14641",
  • "map_id": "258670",
  • "unit_number": "E13",
  • "area": 700,
  • "is_affordable_housing_unit": false,
  • "view_image_url": null,
  • "secondary_view_image_url": null,
  • "created_at": "2017-09-11T17:09:18+00:00",
  • "updated_at": "2018-01-20T03:44:39+00:00"
}

List unit outbound links

Returns a list of unit outbound links.

Requires sightmap.unit-outbound-links.read permission.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

Responses

Response samples

Content type
application/json
{
  • "paging": {
    • "per_page": 100,
    • "current_page": 1,
    • "prev_url": null,
    • "next_url": null
    },
  • "data": [
    • {
      }
    ]
}

Create a unit outbound link

Create a unit outbound link for an asset.

Requires sightmap.unit-outbound-links.create permission.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

Request Body schema: application/json
required
One of
asset_id
required
string <id> <= 255 characters

The asset the outbound link belongs to.

name
required
string <= 255 characters
label
string or null <= 95 characters

The text label on the outbound link.

type
required
string
Enum: "iframe_api" "url_template" "urls_per_unit"

The type determines how the unit outbound link behaves in the application and what actionable data is stored.

  • url_template: A templated URL which can be generated for all units given a few unit specific variables.
  • urls_per_unit: A list of fully qualified URLs for each unit.
  • iframe_api: The link fires an IFrame API event using a unique key, which is provided via the event_key property. No URL is navigated to.
icon_type
string
Enum: "email" "print" "reserve" "share" "search" "info" "video_camera" "video_play" "virtual_tour" "360_tour" "calendar" "floorplan" "form" "location" "person" "photo" "photo_and_tour" "plus_sign" "smartphone" "telephone"

Icon displayed by the outbound link.

event_key
required
string <= 63 characters [a-z0-9-]

A value used in all IFrame event names for the outbound link. For example when event_key is foo, the event name for when the user clicks on the outbound link will be outbound.foo.click.

Responses

Request samples

Content type
application/json
Example
{
  • "asset_id": "1323",
  • "name": "Chat",
  • "label": "Chat With Us",
  • "type": "iframe_api",
  • "icon_type": "person",
  • "event_key": "chatbot"
}

Response samples

Content type
application/json
Example
{
  • "id": "6011",
  • "asset_id": "1323",
  • "name": "Chat",
  • "label": "Chat With Us",
  • "type": "iframe_api",
  • "icon_type": "person",
  • "event_key": "chatbot",
  • "created_at": "2017-09-11T17:09:17+00:00",
  • "updated_at": "2019-01-02T22:01:09+00:00"
}

View a unit outbound link

Returns a specific unit outbound link.

Requires sightmap.unit-outbound-links.read permission.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

outbound-link
required
string <id> <= 255 characters

A unit outbound link ID.

Responses

Response samples

Content type
application/json
Example
{
  • "id": "6011",
  • "asset_id": "1323",
  • "name": "Chat",
  • "label": "Chat With Us",
  • "type": "iframe_api",
  • "icon_type": "person",
  • "event_key": "chatbot",
  • "created_at": "2017-09-11T17:09:17+00:00",
  • "updated_at": "2019-01-02T22:01:09+00:00"
}

Update a unit outbound link

Requires sightmap.unit-outbound-links.create permission.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

outbound-link
required
string <id> <= 255 characters

A unit outbound link ID.

Request Body schema: application/json
required
One of
id
required
string <id> <= 255 characters
asset_id
required
string <id> <= 255 characters

The asset the outbound link belongs to.

name
string <= 255 characters
label
string or null <= 95 characters

The text label on the outbound link.

type
required
string
Enum: "iframe_api" "url_template" "urls_per_unit"

The type determines how the unit outbound link behaves in the application and what actionable data is stored.

  • url_template: A templated URL which can be generated for all units given a few unit specific variables.
  • urls_per_unit: A list of fully qualified URLs for each unit.
  • iframe_api: The link fires an IFrame API event using a unique key, which is provided via the event_key property. No URL is navigated to.
icon_type
string
Enum: "email" "print" "reserve" "share" "search" "info" "video_camera" "video_play" "virtual_tour" "360_tour" "calendar" "floorplan" "form" "location" "person" "photo" "photo_and_tour" "plus_sign" "smartphone" "telephone"

Icon displayed by the outbound link.

event_key
string <= 63 characters [a-z0-9-]

A value used in all IFrame event names for the outbound link. For example when event_key is foo, the event name for when the user clicks on the outbound link will be outbound.foo.click.

Responses

Request samples

Content type
application/json
Example
{
  • "id": "6011",
  • "asset_id": "1323",
  • "name": "Chat",
  • "label": "Chat With Us",
  • "type": "iframe_api",
  • "icon_type": "person",
  • "event_key": "chatbot"
}

Response samples

Content type
application/json
Example
{
  • "id": "6011",
  • "asset_id": "1323",
  • "name": "Chat",
  • "label": "Chat With Us",
  • "type": "iframe_api",
  • "icon_type": "person",
  • "event_key": "chatbot",
  • "created_at": "2017-09-11T17:09:17+00:00",
  • "updated_at": "2019-01-02T22:01:09+00:00"
}

List unit outbound link URLs

Returns a list of URLs for each unit when the unit outbound link type is urls_per_unit.

Requires sightmap.unit-outbound-links.read permission.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

outbound-link
required
string <id> <= 255 characters

A unit outbound link ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

Responses

Response samples

Content type
application/json
{}

Update unit outbound link URLs

Update a URL for any or all units when the unit outbound link type is urls_per_unit.

Requires sightmap.unit-outbound-links.update permission.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

outbound-link
required
string <id> <= 255 characters

A unit outbound link ID.

Request Body schema: application/json
required
Array of objects
Array
unit_id
required
string <id> <= 255 characters
url
required
string or null

A fully qualified URL assigned to the unit.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "message": "No API key found in request"
}

List asset outbound links

Returns a list of asset outbound links.

Requires sightmap.asset-outbound-links.read permission.

NOTICE: This resource is experimental and requires the asset-outbound-links-resource experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the asset-outbound-links-resource experimental flag.

Responses

Response samples

Content type
application/json
{
  • "paging": {
    • "per_page": 100,
    • "current_page": 1,
    • "prev_url": null,
    • "next_url": null
    },
  • "data": [
    • {
      }
    ]
}

Create an asset outbound link

Create an asset outbound link for an asset.

Requires sightmap.asset-outbound-links.create permission.

NOTICE: This resource is experimental and requires the asset-outbound-links-resource experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the asset-outbound-links-resource experimental flag.

Request Body schema: application/json
required
asset_id
required
string <id> <= 255 characters

The asset the outbound link belongs to.

name
required
string <= 255 characters
template
required
string

Outbound link template.

label
required
string <= 95 characters

The text label on the outbound link.

icon_type
string
Enum: "email" "print" "reserve" "share" "search" "info" "video_camera" "video_play" "virtual_tour" "360_tour" "calendar" "floorplan" "form" "location" "person" "photo" "photo_and_tour" "plus_sign" "smartphone" "telephone"

Icon displayed by the outbound link.

open_new_window
required
boolean

Determines if the outbound link will open in a new browser window or not.

Responses

Request samples

Content type
application/json
{
  • "asset_id": "1323",
  • "name": "Contact",
  • "template": "mailto:nobody@example.com",
  • "label": "Contact Us",
  • "icon_type": "email",
  • "open_new_window": true
}

Response samples

Content type
application/json
{
  • "id": "6011",
  • "asset_id": "1323",
  • "name": "Contact",
  • "template": "mailto:nobody@example.com",
  • "label": "Contact Us",
  • "icon_type": "email",
  • "open_new_window": true,
  • "created_at": "2017-09-11T17:09:17+00:00",
  • "updated_at": "2019-01-02T22:01:09+00:00"
}

View an asset outbound link

Returns a specific asset outbound link.

Requires sightmap.asset-outbound-links.read permission.

NOTICE: This resource is experimental and requires the asset-outbound-links-resource experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

outbound-link
required
string <id> <= 255 characters

An asset outbound link ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the asset-outbound-links-resource experimental flag.

Responses

Response samples

Content type
application/json
{
  • "id": "6011",
  • "asset_id": "1323",
  • "name": "Contact",
  • "template": "mailto:nobody@example.com",
  • "label": "Contact Us",
  • "icon_type": "email",
  • "open_new_window": true,
  • "created_at": "2017-09-11T17:09:17+00:00",
  • "updated_at": "2019-01-02T22:01:09+00:00"
}

Update an asset outbound link

Requires sightmap.asset-outbound-links.update permission.

NOTICE: This resource is experimental and requires the asset-outbound-links-resource experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

outbound-link
required
string <id> <= 255 characters

An asset outbound link ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the asset-outbound-links-resource experimental flag.

Request Body schema: application/json
required
id
required
string <id> <= 255 characters
asset_id
required
string <id> <= 255 characters

The asset the outbound link belongs to.

name
string <= 255 characters
template
string

Outbound link template.

label
string <= 95 characters

The text label on the outbound link.

icon_type
string
Enum: "email" "print" "reserve" "share" "search" "info" "video_camera" "video_play" "virtual_tour" "360_tour" "calendar" "floorplan" "form" "location" "person" "photo" "photo_and_tour" "plus_sign" "smartphone" "telephone"

Icon displayed by the outbound link.

open_new_window
boolean

Determines if the outbound link will open in a new browser window or not.

Responses

Request samples

Content type
application/json
{
  • "id": "6011",
  • "asset_id": "1323",
  • "name": "Contact",
  • "template": "mailto:nobody@example.com",
  • "label": "Contact Us",
  • "icon_type": "email",
  • "open_new_window": true
}

Response samples

Content type
application/json
{
  • "id": "6011",
  • "asset_id": "1323",
  • "name": "Contact",
  • "template": "mailto:nobody@example.com",
  • "label": "Contact Us",
  • "icon_type": "email",
  • "open_new_window": true,
  • "created_at": "2017-09-11T17:09:17+00:00",
  • "updated_at": "2019-01-02T22:01:09+00:00"
}

Landing Pages

List landing pages

Returns a list of landing pages for an asset.

Requires sightmap.landing-pages.read permission.

NOTICE: This resource is experimental and requires the landing-page-resource experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

asset
string <id> <= 255 characters

An asset ID to filter the list on.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the landing-page-resource experimental flag.

Responses

Response samples

Content type
application/json
{
  • "paging": {
    • "per_page": 100,
    • "current_page": 1,
    • "prev_url": null,
    • "next_url": null
    },
  • "data": []
}

View a landing page

Returns a specific landing page.

Requires sightmap.landing-pages.read permission.

NOTICE: This resource is experimental and requires the landing-page-resource experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

landing-page
required
string <id> <= 255 characters

A landing page ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the landing-page-resource experimental flag.

Responses

Response samples

Content type
application/json
{}

Unit Descriptions

List groups

Returns a list of unit description groups for an asset.

Requires sightmap.unit-descriptions.read permission.

NOTICE: This resource is experimental and requires the unit-descriptions-resource experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the unit-descriptions-resource experimental flag.

Responses

Response samples

Content type
application/json
{
  • "paging": {
    • "per_page": 100,
    • "current_page": 1,
    • "prev_url": null,
    • "next_url": null
    },
  • "data": [
    • {
      }
    ]
}

Create a group

Create a unit description group.

Requires sightmap.unit-descriptions.create permission.

NOTICE: This resource is experimental and requires the unit-descriptions-resource experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the unit-descriptions-resource experimental flag.

Request Body schema: application/json
required
asset_id
required
string <id> <= 255 characters

The asset the unit description group belongs to.

name
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "asset_id": "1323",
  • "name": "Amenities"
}

Response samples

Content type
application/json
{
  • "id": "7",
  • "asset_id": "1323",
  • "name": "Amenities",
  • "created_at": "2017-09-11T17:09:17+00:00",
  • "updated_at": "2019-01-02T22:01:09+00:00"
}

View a group

Returns a specific unit description group.

Requires sightmap.unit-descriptions.read permission.

NOTICE: This resource is experimental and requires the unit-descriptions-resource experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

group
required
string <id> <= 255 characters

A unit description group ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the unit-description-resource experimental flag.

Responses

Response samples

Content type
application/json
{
  • "id": "7",
  • "asset_id": "1323",
  • "name": "Amenities",
  • "created_at": "2017-09-11T17:09:17+00:00",
  • "updated_at": "2019-01-02T22:01:09+00:00"
}

Update a group

Update a unit description group.

Requires sightmap.unit-descriptions.update permission.

NOTICE: This resource is experimental and requires the unit-descriptions-resource experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

group
required
string <id> <= 255 characters

A unit description group ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the unit-description-resource experimental flag.

Request Body schema: application/json
required
id
required
string <id> <= 255 characters
asset_id
required
string <id> <= 255 characters

The asset the unit description group belongs to.

name
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "id": "7",
  • "asset_id": "1323",
  • "name": "Amenities"
}

Response samples

Content type
application/json
{
  • "id": "7",
  • "asset_id": "1323",
  • "name": "Amenities",
  • "created_at": "2017-09-11T17:09:17+00:00",
  • "updated_at": "2019-01-02T22:01:09+00:00"
}

List descriptions

Returns a list of descriptions for a unit description group.

Requires sightmap.unit-descriptions.read permission.

NOTICE: This resource is experimental and requires the unit-descriptions-resource experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

group
required
string <id> <= 255 characters

A unit description group ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the unit-descriptions-resource experimental flag.

Responses

Response samples

Content type
application/json
{
  • "paging": {
    • "per_page": 100,
    • "current_page": 1,
    • "prev_url": null,
    • "next_url": null
    },
  • "data": [
    • {
      }
    ]
}

Create a description

Create one or more unit descriptions.

Requires sightmap.unit-descriptions.create permission.

NOTICE: This resource is experimental and requires the unit-descriptions-resource experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

group
required
string <id> <= 255 characters

A unit description group ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the unit-descriptions-resource experimental flag.

Request Body schema: application/json
required
Array of objects
Array
group_id
required
string <id> <= 255 characters

The unit description group the description belongs to.

name
required
string <= 255 characters
label
required
string <= 15 characters

The tab label displayed in the application.

body
required
string <= 2000 characters

The text content displayed in the application, which is expected to be plain text or basic syntax Markdown.

is_enabled
required
boolean

Determines whether or not the description should be displayed in the application.

Responses

Request samples

Content type
application/json
{
  • "data": [
    • {
      },
    • {
      }
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    • {
      },
    • {
      }
    ]
}

Update a description

Update one or more unit descriptions.

Requires sightmap.unit-descriptions.update permission.

NOTICE: This resource is experimental and requires the unit-descriptions-resource experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

group
required
string <id> <= 255 characters

A unit description group ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the unit-descriptions-resource experimental flag.

Request Body schema: application/json
required
Array of objects
Array
id
required
string <id> <= 255 characters
group_id
required
string <id> <= 255 characters

The unit description group the description belongs to.

name
string <= 255 characters
label
string <= 15 characters

The tab label displayed in the application.

body
string <= 2000 characters

The text content displayed in the application, which is expected to be plain text or basic syntax Markdown.

is_enabled
boolean

Determines whether or not the description should be displayed in the application.

Responses

Request samples

Content type
application/json
{
  • "data": [
    • {
      },
    • {
      }
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    • {
      },
    • {
      }
    ]
}

View a description

Returns a specific unit description.

Requires sightmap.unit-descriptions.read permission.

NOTICE: This resource is experimental and requires the unit-descriptions-resource experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

group
required
string <id> <= 255 characters

A unit description group ID.

description
required
string <id> <= 255 characters

A unit description ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the unit-description-resource experimental flag.

Responses

Response samples

Content type
application/json
{
  • "id": "1000",
  • "asset_id": "1323",
  • "group_id": "7",
  • "name": "Amenity 1",
  • "label": "Amenities",
  • "body": "* Quartz countertops\n* Mountain views\n* Stainless steel appliances\n",
  • "is_enabled": true,
  • "created_at": "2017-09-11T17:09:17+00:00",
  • "updated_at": "2019-01-02T22:01:09+00:00"
}

List units assigned to descriptions

Returns a list of units for a unit description group.

Requires sightmap.unit-descriptions.read permission.

NOTICE: This resource is experimental and requires the unit-descriptions-resource experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

group
required
string <id> <= 255 characters

A unit description group ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the unit-descriptions-resource experimental flag.

Responses

Response samples

Content type
application/json
{
  • "paging": {
    • "per_page": 100,
    • "current_page": 1,
    • "prev_url": null,
    • "next_url": null
    },
  • "data": [
    • {
      }
    ]
}

Assign units to descriptions

Assign one or more units to one or more descriptions.

Requires sightmap.unit-descriptions.update permission.

NOTICE: This resource is experimental and requires the unit-descriptions-resource experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

group
required
string <id> <= 255 characters

A unit description group ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the unit-descriptions-resource experimental flag.

Request Body schema: application/json
required
Array of objects
Array
group_id
required
string <id> <= 255 characters

The unit description group the relation belongs to.

unit_id
required
string <id> <= 255 characters
description_id
required
string <= 255 characters

The description the units are assigned to.

Responses

Request samples

Content type
application/json
{
  • "data": [
    • {
      },
    • {
      }
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    • {
      },
    • {
      }
    ]
}

Filters

List filters

Returns a list of filters.

Requires sightmap.filters.read permission.

NOTICE: This resource is experimental and requires the filters-resource experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the filters-resource experimental flag.

Responses

Response samples

Content type
application/json
{
  • "paging": {
    • "per_page": 100,
    • "current_page": 1,
    • "prev_url": null,
    • "next_url": null
    },
  • "data": [
    • {
      }
    ]
}

Create a filter

Creates a new filter.

Requires sightmap.filters.create permission.

NOTICE: This resource is experimental and requires the filters-resource experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the filters-resource experimental flag.

Request Body schema: application/json
required
One of
asset_id
required
string <id> <= 255 characters

The asset the filter belongs to.

name
required
string <= 255 characters
label
required
string <= 255 characters
type
required
string
Enum: "floor" "floor_plan" "range" "custom"

The type determines how the filter behaves in the application and what actionable data is stored.

  • custom: A custom filter which requires the assignment of units.
  • floor: A filter that sorts units by floors based on the assigned options.
  • floor_plan: A filter that filters units based on a floor plan.
  • range: A filter that that filters units based on a chosen range type.
is_enabled
boolean
Default: true

Whether or not the filter is enabled.

Responses

Request samples

Content type
application/json
Example
{
  • "asset_id": "1323",
  • "name": "Bathrooms",
  • "label": "Bathrooms",
  • "type": "custom",
  • "is_enabled": true
}

Response samples

Content type
application/json
Example
{
  • "id": "1222",
  • "asset_id": "1323",
  • "type": "custom",
  • "name": "Bathrooms",
  • "label": "Bathrooms",
  • "is_enabled": true,
  • "options": [
    • {
      },
    • {
      },
    • {
      }
    ],
  • "created_at": "2017-09-11T17:09:17+00:00",
  • "updated_at": "2019-01-02T22:01:09+00:00"
}

View a filter

Returns a specific filter.

Requires sightmap.filters.read permission.

NOTICE: This resource is experimental and requires the filters-resource experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

filter
required
string <id> <= 255 characters

A filter ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the filters-resource experimental flag.

Responses

Response samples

Content type
application/json
Example
{
  • "id": "1222",
  • "asset_id": "1323",
  • "type": "custom",
  • "name": "Bathrooms",
  • "label": "Bathrooms",
  • "is_enabled": true,
  • "options": [
    • {
      },
    • {
      },
    • {
      }
    ],
  • "created_at": "2017-09-11T17:09:17+00:00",
  • "updated_at": "2019-01-02T22:01:09+00:00"
}

Update a filter

Updates a filter.

When updating a filter, the filter type cannot be changed.

Requires sightmap.filters.update permission.

NOTICE: This resource is experimental and requires the filters-resource experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

filter
required
string <id> <= 255 characters

A filter ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the filters-resource experimental flag.

Request Body schema: application/json
required
One of
id
required
string <id> <= 255 characters
asset_id
required
string <id> <= 255 characters

The asset the filter belongs to.

name
string <= 255 characters
label
string <= 255 characters
type
required
string
Enum: "floor" "floor_plan" "range" "custom"

The type determines how the filter behaves in the application and what actionable data is stored.

  • custom: A custom filter which requires the assignment of units.
  • floor: A filter that sorts units by floors based on the assigned options.
  • floor_plan: A filter that filters units based on a floor plan.
  • range: A filter that that filters units based on a chosen range type.
is_enabled
boolean
Default: true

Whether or not the filter is enabled.

Responses

Request samples

Content type
application/json
Example
{
  • "id": "1",
  • "asset_id": "1323",
  • "name": "Bathrooms",
  • "label": "Bathrooms",
  • "type": "custom",
  • "is_enabled": true
}

Response samples

Content type
application/json
Example
{
  • "id": "1222",
  • "asset_id": "1323",
  • "type": "custom",
  • "name": "Bathrooms",
  • "label": "Bathrooms",
  • "is_enabled": true,
  • "options": [
    • {
      },
    • {
      },
    • {
      }
    ],
  • "created_at": "2017-09-11T17:09:17+00:00",
  • "updated_at": "2019-01-02T22:01:09+00:00"
}

List options

Returns a list of options.

Requires sightmap.filters.read permission.

NOTICE: This resource is experimental and requires the filters-resource experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

filter
required
string <id> <= 255 characters

A filter ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the filters-resource experimental flag.

Responses

Response samples

Content type
application/json
{
  • "paging": {
    • "per_page": 100,
    • "current_page": 1,
    • "prev_url": null,
    • "next_url": null
    },
  • "data": [
    • {
      }
    ]
}

Create an option

Creates a new option for a filter.

Requires sightmap.filters.create permission.

NOTICE: This resource is experimental and requires the filters-resource experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

filter
required
string <id> <= 255 characters

A filter ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the filters-resource experimental flag.

Request Body schema: application/json
required
One of
asset_id
required
string <id> <= 255 characters

The asset the option belongs to.

filter_id
required
string <id> <= 255 characters

The filter the option belongs to.

type
required
string
Enum: "floor" "floor_plan" "range" "custom"

The type determines how the filter option behaves in the application and what actionable data is stored.

The type must match the type of the filter it belongs to.

  • custom: A custom filter option which requires the assignment of units.
  • floor: A filter option that sorts units by floors based on the assigned options.
  • floor_plan: A filter option that filters units based on a floor plan.
  • range: A filter option that that filters units based on a chosen range type.
label
required
string <= 255 characters
sort
integer <int32> <= 255 characters

The sort order of the option.

is_enabled
boolean
Default: true

Whether or not the option is enabled.

Responses

Request samples

Content type
application/json
Example
{
  • "asset_id": "1323",
  • "filter_id": "1",
  • "type": "custom",
  • "label": "0 - 3",
  • "sort": 0,
  • "is_enabled": true
}

Response samples

Content type
application/json
Example
{
  • "id": "1",
  • "asset_id": "1323",
  • "filter_id": "1",
  • "type": "custom",
  • "label": "0 - 3",
  • "sort": 0,
  • "created_at": "2017-09-11T17:09:17+00:00",
  • "updated_at": "2019-01-02T22:01:09+00:00"
}

View an option

Returns a specific filter.

Requires sightmap.filters.read permission.

NOTICE: This resource is experimental and requires the filters-resource experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

filter
required
string <id> <= 255 characters

A filter ID.

option
required
string <id> <= 255 characters

An option ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the filters-resource experimental flag.

Responses

Response samples

Content type
application/json
Example
{
  • "id": "1",
  • "asset_id": "1323",
  • "filter_id": "1",
  • "type": "custom",
  • "label": "0 - 3",
  • "sort": 0,
  • "created_at": "2017-09-11T17:09:17+00:00",
  • "updated_at": "2019-01-02T22:01:09+00:00"
}

Update an option

Updates an option.

Requires sightmap.filters.update permission.

NOTICE: This resource is experimental and requires the filters-resource experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

filter
required
string <id> <= 255 characters

A filter ID.

option
required
string <id> <= 255 characters

An option ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the filters-resource experimental flag.

Request Body schema: application/json
required
One of
id
required
string <id> <= 255 characters
asset_id
required
string <id> <= 255 characters

The asset the filter belongs to.

filter_id
required
string <id> <= 255 characters

The filter the option belongs to.

type
required
string <= 255 characters

The type must match the filter type.

label
string <= 255 characters
sort
integer <int32> <= 255 characters

The sort order of the option.

is_enabled
boolean
Default: true

Whether or not the filter is enabled.

Responses

Request samples

Content type
application/json
Example
{
  • "id": "8267",
  • "asset_id": "1323",
  • "filter_id": "1",
  • "type": "custom",
  • "label": "0 - 3",
  • "sort": 0,
  • "is_enabled": true
}

Response samples

Content type
application/json
Example
{
  • "id": "1",
  • "asset_id": "1323",
  • "filter_id": "1",
  • "type": "custom",
  • "label": "0 - 3",
  • "sort": 0,
  • "created_at": "2017-09-11T17:09:17+00:00",
  • "updated_at": "2019-01-02T22:01:09+00:00"
}

List units assigned to a custom option

Returns a list of units for a custom option.

Requires sightmap.filters.read permission.

NOTICE: This resource is experimental and requires the filters-resource experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

filter
required
string <id> <= 255 characters

A filter ID.

option
required
string <id> <= 255 characters

An option ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the filters-resource experimental flag.

Responses

Response samples

Content type
application/json
{
  • "paging": {
    • "per_page": 100,
    • "current_page": 1,
    • "prev_url": null,
    • "next_url": null
    },
  • "data": [
    • {
      }
    ]
}

Assign units to a custom option

Assign one or more units to one or more options.

Requires sightmap.filters.update permission.

NOTICE: This resource is experimental and requires the filters-resource experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

filter
required
string <id> <= 255 characters

A filter ID.

option
required
string <id> <= 255 characters

An option ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the filters-resource experimental flag.

Request Body schema: application/json
required
Array of objects
Array
asset_id
required
string <id> <= 255 characters

The asset the option belongs to.

filter_id
required
string <id> <= 255 characters

The filter the option belongs to.

option_id
required
string <id> <= 255 characters
unit_id
required
string <= 255 characters

The unit the option belongs to.

Responses

Request samples

Content type
application/json
{
  • "data": [
    • {
      },
    • {
      }
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    • {
      },
    • {
      }
    ]
}

Floors

List floors

Returns a list of floors for an asset.

Requires sightmap.floors.read permission.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

Responses

Response samples

Content type
application/json
{
  • "paging": {
    • "per_page": 100,
    • "current_page": 1,
    • "prev_url": null,
    • "next_url": null
    },
  • "data": [
    • {
      }
    ]
}

Create a floor

Create a floor for an asset.

Requires sightmap.floors.create permission.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

Request Body schema: application/json
required
asset_id
required
string <id> <= 255 characters

The asset the floor belongs to.

name
required
string <= 255 characters
filter_label
required
string <= 255 characters

The default filter label for the floor.

filter_short_label
required
string <= 4 characters

The default short filter label for the floor.

sort
required
integer <int32>

The sort order of the floor.

Responses

Request samples

Content type
application/json
{
  • "asset_id": "1323",
  • "name": "1",
  • "filter_label": "Floor 1",
  • "filter_short_label": "1",
  • "sort": 2
}

Response samples

Content type
application/json
{
  • "id": "4730",
  • "asset_id": "1323",
  • "name": "1",
  • "filter_label": "Floor 1",
  • "filter_short_label": "1",
  • "sort": 2,
  • "created_at": "2017-09-11T17:09:17+00:00",
  • "updated_at": "2019-01-02T22:01:09+00:00"
}

View a floor

Returns a specific floor.

Requires sightmap.floors.read permission.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

floor
required
string <id> <= 255 characters

A floor ID.

Responses

Response samples

Content type
application/json
{
  • "id": "4730",
  • "asset_id": "1323",
  • "name": "1",
  • "filter_label": "Floor 1",
  • "filter_short_label": "1",
  • "sort": 2,
  • "created_at": "2017-09-11T17:09:17+00:00",
  • "updated_at": "2019-01-02T22:01:09+00:00"
}

Update a floor

Requires sightmap.floors.update permission.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

floor
required
string <id> <= 255 characters

A floor ID.

Request Body schema: application/json
required
id
required
string <id> <= 255 characters
asset_id
required
string <id> <= 255 characters

The asset the floor belongs to.

name
string <= 255 characters
filter_label
string <= 255 characters

The default filter label for the floor.

filter_short_label
string <= 4 characters

The default short filter label for the floor.

sort
integer <int32>

The sort order of the floor.

Responses

Request samples

Content type
application/json
{
  • "id": "4730",
  • "asset_id": "1323",
  • "name": "1",
  • "filter_label": "Floor 1",
  • "filter_short_label": "1",
  • "sort": 2
}

Response samples

Content type
application/json
{
  • "id": "4730",
  • "asset_id": "1323",
  • "name": "1",
  • "filter_label": "Floor 1",
  • "filter_short_label": "1",
  • "sort": 2,
  • "created_at": "2017-09-11T17:09:17+00:00",
  • "updated_at": "2019-01-02T22:01:09+00:00"
}

Floor Plans

List floor plans

Returns a list of floor plans for an asset.

Requires sightmap.floor-plans.read permission.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

Responses

Response samples

Content type
application/json
{}

Create a floor plan

Create a floor plan for an asset.

Requires sightmap.floor-plans.create permission.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

Request Body schema:
required
asset_id
required
string <id> <= 255 characters

The asset the floor plan belongs to.

name
required
string <= 255 characters
bedroom_count
required
integer <int32> >= 0

The number of bedrooms.

bathroom_count
required
number <float> >= 0

The number of bathrooms. Fractional values represent partial baths (e.g. 1.5 is 1 1/2 baths).

filter_label
required
string <= 255 characters

Responses

Request samples

Content type
{
  • "asset_id": "1323",
  • "name": "1 Bed 1 Bath",
  • "bedroom_count": 1,
  • "bathroom_count": 1,
  • "filter_label": "1 Bed 1 Bath"
}

Response samples

Content type
application/json
{}

View a floor plan

Returns a specific floor plan.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

floor-plan
required
string <id> <= 255 characters

A floor plan ID.

Responses

Response samples

Content type
application/json
{}

Update a floor plan

Requires sightmap.floor-plans.update permission.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

floor-plan
required
string <id> <= 255 characters

A floor plan ID.

Request Body schema:
required
id
required
string <id> <= 255 characters
asset_id
required
string <id> <= 255 characters

The asset the floor plan belongs to.

name
string <= 255 characters
bedroom_count
integer <int32> >= 0

The number of bedrooms.

bathroom_count
number <float> >= 0

The number of bathrooms. Fractional values represent partial baths (e.g. 1.5 is 1 1/2 baths).

image
string
Value: "delete"

Delete the primary image of the floor plan.

secondary_image
string
Value: "delete"

Delete the secondary image of the floor plan.

filter_label
string <= 65 characters

Responses

Request samples

Content type
{
  • "id": "14641",
  • "asset_id": "1323",
  • "name": "1 Bed 1 Bath",
  • "bedroom_count": 1,
  • "bathroom_count": 1,
  • "filter_label": "1 Bed 1 Bath"
}

Response samples

Content type
application/json
{}

Delete a floor plan

Requires sightmap.floor-plans.delete permission.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

floor-plan
required
string <id> <= 255 characters

A floor plan ID.

Responses

Response samples

Content type
application/json
{}

Buildings

List buildings

Returns a list of buildings for an asset.

Requires sightmap.buildings.read permission.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

Responses

Response samples

Content type
application/json
{
  • "paging": {
    • "per_page": 100,
    • "current_page": 1,
    • "prev_url": null,
    • "next_url": null
    },
  • "data": [
    • {
      }
    ]
}

Create a building

Create a building for an asset.

Requires sightmap.buildings.create permission.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

Request Body schema: application/json
required
asset_id
required
string <id> <= 255 characters

The asset the building belongs to.

name
required
string <= 255 characters
label
string <= 255 characters

If not provided, the building's name will be used.

Responses

Request samples

Content type
application/json
{
  • "asset_id": "1323",
  • "name": "W",
  • "label": "W"
}

Response samples

Content type
application/json
{
  • "id": "8267",
  • "asset_id": "1323",
  • "name": "W",
  • "label": "W",
  • "created_at": "2017-09-11T17:09:18+00:00",
  • "updated_at": "2017-09-11T17:09:18+00:00"
}

View a building

Returns a specific building.

Requires sightmap.buildings.read permission.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

building
required
string <id> <= 255 characters

A building ID.

Responses

Response samples

Content type
application/json
{
  • "id": "8267",
  • "asset_id": "1323",
  • "name": "W",
  • "label": "W",
  • "created_at": "2017-09-11T17:09:18+00:00",
  • "updated_at": "2017-09-11T17:09:18+00:00"
}

Update a building

Requires sightmap.buildings.update permission.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

building
required
string <id> <= 255 characters

A building ID.

Request Body schema: application/json
required
id
required
string <id> <= 255 characters
asset_id
required
string <id> <= 255 characters

The asset the building belongs to.

name
required
string <= 255 characters
label
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "id": "8267",
  • "asset_id": "1323",
  • "name": "W",
  • "label": "W"
}

Response samples

Content type
application/json
{
  • "id": "8267",
  • "asset_id": "1323",
  • "name": "W",
  • "label": "W",
  • "created_at": "2017-09-11T17:09:18+00:00",
  • "updated_at": "2017-09-11T17:09:18+00:00"
}

Marker Descriptions

List marker descriptions

Returns a list of marker descriptions for an asset.

Requires sightmap.marker-descriptions.read permission.

NOTICE: This resource is experimental and requires the marker-descriptions-resource experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the marker-descriptions-resource experimental flag.

Responses

Response samples

Content type
application/json
{
  • "paging": {
    • "per_page": 100,
    • "current_page": 1,
    • "prev_url": null,
    • "next_url": null
    },
  • "data": [
    • {
      }
    ]
}

View a marker description

Returns a specific marker description.

Requires sightmap.marker-descriptions.read permission.

NOTICE: This resource is experimental and requires the marker-descriptions-resource experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

marker-description
required
string <id> <= 255 characters

A Marker Description ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the marker-descriptions-resource experimental flag.

Responses

Response samples

Content type
application/json
{
  • "id": "8267",
  • "asset_id": "1323",
  • "gallery_id": "3321",
  • "name": "Infinity Pool",
  • "label": "Infinity Pool",
  • "description": "An infinity pool is a reflecting or swimming pool, where the water flows over one or more edges, producing a visual effect of water with no boundary. Such pools are often designed so that the edge appears to merge with a larger body of water such as the ocean, or with the sky. They are often seen at resorts, estates, and in other luxurious places.",
  • "iframe_source_url": null,
  • "outbound_link_url": "https://engrain.com/",
  • "created_at": "2017-09-11T17:09:18+00:00",
  • "updated_at": "2017-09-11T17:09:18+00:00"
}

Image Galleries

List galleries

Returns a list of image galleries for an asset.

Requires sightmap.galleries.read permission.

NOTICE: This resource is experimental and requires the gallery-resource experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the gallery-resource experimental flag.

Responses

Response samples

Content type
application/json
{}

View a gallery

Returns a specific image gallery.

NOTICE: This resource is experimental and requires the gallery-resource experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

gallery
required
string <id> <= 255 characters

A gallery ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the gallery-resource experimental flag.

Responses

Response samples

Content type
application/json
{}

Unit Maps

List unit maps

Returns a list of unit maps for an asset.

Requires sightmap.unit-maps.read permission.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

tags
string <id> <= 255 characters

A comma-separated list of one or more tags to filter the list on (e.g. tag-1,tag-2).

Responses

Response samples

Content type
application/json
{}

Create a unit map

Create a Unit Map for an asset.

Requires sightmap.unit-maps.create permission.

NOTICE: This resource is experimental and requires the create-unitmap-resource experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the create-unitmap-resource experimental flag.

Request Body schema: multipart/form-data
required
required
object
asset_id
required
string <id> <= 255 characters

The asset the unit map belongs to.

name
required
string <= 255 characters
tags
Array of strings <= 255 characters <= 3 items ^[a-z]{1}[a-z0-9-]{1,254}$

The tags assigned to the unit map.

style
required
string
Enum: "a" "a.1" "a.2" "b" "c" "d" "e" "f.1" "f.2" "f.3" "g.1" "g.2" "h" "x"

The defined style of the unit map.

This field is required when file or source is provided.

file
required
string <binary>

The unit map file. Must be a .umap file.

source
required
string <binary>

The unit map source file. Must be either an .svg, .ai, or .pdf file.

Responses

Response samples

Content type
application/json
{}

View a unit map

Returns a specific unit map.

Requires sightmap.unit-maps.read permission.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

map
required
string <id> <= 255 characters

A unit map ID.

Responses

Response samples

Content type
application/json
{}

Update a unit map

Requires sightmap.unit-maps.update permission.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

map
required
string <id> <= 255 characters

A unit map ID.

Request Body schema:
required
id
required
string <id> <= 255 characters
asset_id
required
string <id> <= 255 characters

The asset the unit map belongs to.

name
string <= 255 characters
tags
Array of strings <= 255 characters <= 3 items ^[a-z]{1}[a-z0-9-]{1,254}$

The tags assigned to the unit map.

is_dimension_locked
boolean
Default: false
style
string
Enum: "a" "a.1" "a.2" "b" "c" "d" "e" "f.1" "f.2" "f.3" "g.1" "g.2" "h" "x"

The defined style of the unit map.

Responses

Request samples

Content type
{
  • "id": "575",
  • "asset_id": "1323",
  • "name": "The Lofts at New Main",
  • "tags": [
    • "ils",
    • "mls"
    ],
  • "style": "b"
}

Response samples

Content type
application/json
{}

List backgrounds

Returns a list of backgrounds for the unit map.

Requires sightmap.unit-maps.read permission.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

map
required
string <id> <= 255 characters

A unit map ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

Responses

Response samples

Content type
application/json
{}

View a background

Returns a specific background for a unit map.

Requires sightmap.unit-maps.read permission.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

map
required
string <id> <= 255 characters

A unit map ID.

background
required
string <id> <= 255 characters

A background ID.

Responses

Response samples

Content type
application/json
{}

Caches

Build caches

Builds and/or rebuilds all caches for an asset.

Requires sightmap.caches.build permission.

NOTICE: This resource is experimental and requires the build-caches experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the build-caches experimental flag.

Responses

Response samples

Content type
application/json
{
  • "message": "No API key found in request"
}

Asset References

References provide asset ID mappings to other third-party systems.

List references

Returns a list of asset references for an asset.

Requires sightmap.asset-references.read permission.

NOTICE: This resource is experimental and requires the references experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the references experimental flag.

Responses

Response samples

Content type
application/json
{
  • "paging": {
    • "per_page": 100,
    • "current_page": 1,
    • "prev_url": null,
    • "next_url": null
    },
  • "data": [
    • {
      }
    ]
}

Create a reference

Create an asset reference for an asset.

Requires sightmap.asset-references.create permission.

NOTICE: This resource is experimental and requires the references experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the references experimental flag.

Request Body schema: application/json
required
asset_id
required
string <id> <= 255 characters

The asset the reference belongs to.

name
required
string <= 255 characters
description
string or null <= 255 characters
key
string or null <= 255 characters ^[a-z]{1}[a-z0-9-]{1,254}$

A string used across resources to indicate the third-party system the reference value is part of.

The key cannot be used more than once per asset, which ensures only a single reference may exist per asset for each key.

value
required
string <= 255 characters

The matched reference value to the asset.

Responses

Request samples

Content type
application/json
{
  • "asset_id": "4715",
  • "name": "Google Places",
  • "key": "google-places",
  • "value": "ChIJuw4JzfOGbIcR1PPArQtuTcQ"
}

Response samples

Content type
application/json
{
  • "id": "2630",
  • "asset_id": "4715",
  • "name": "Google Places",
  • "description": null,
  • "key": "google-places",
  • "value": "ChIJuw4JzfOGbIcR1PPArQtuTcQ",
  • "created_at": "2021-03-11T17:09:18+00:00",
  • "updated_at": "2021-01-20T03:44:39+00:00"
}

View a reference

Returns a specific asset reference.

Requires sightmap.asset-references.read permission.

NOTICE: This resource is experimental and requires the references experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

reference
required
string <id> <= 255 characters

An asset reference ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the references experimental flag.

Responses

Response samples

Content type
application/json
{
  • "id": "2630",
  • "asset_id": "4715",
  • "name": "Google Places",
  • "description": null,
  • "key": "google-places",
  • "value": "ChIJuw4JzfOGbIcR1PPArQtuTcQ",
  • "created_at": "2021-03-11T17:09:18+00:00",
  • "updated_at": "2021-01-20T03:44:39+00:00"
}

Update a reference

Requires sightmap.asset-references.update permission.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

reference
required
string <id> <= 255 characters

An asset reference ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the references experimental flag.

Request Body schema: application/json
required
id
required
string <id> <= 255 characters
asset_id
required
string <id> <= 255 characters

The asset the reference belongs to.

name
string <= 255 characters
description
string or null <= 255 characters
key
string or null <= 255 characters ^[a-z]{1}[a-z0-9-]{1,254}$

A string used across resources to indicate the third-party system the reference value is part of.

The key cannot be used more than once per asset, which ensures only a single reference may exist per asset for each key.

value
required
string <= 255 characters

The matched reference value to the asset.

Responses

Request samples

Content type
application/json
{
  • "id": "2630",
  • "asset_id": "4715",
  • "name": "Google Places",
  • "description": null,
  • "key": "google-places",
  • "value": "ChIJuw4JzfOGbIcR1PPArQtuTcQ"
}

Response samples

Content type
application/json
{
  • "id": "2630",
  • "asset_id": "4715",
  • "name": "Google Places",
  • "description": null,
  • "key": "google-places",
  • "value": "ChIJuw4JzfOGbIcR1PPArQtuTcQ",
  • "created_at": "2021-03-11T17:09:18+00:00",
  • "updated_at": "2021-01-20T03:44:39+00:00"
}

Unit References

References provide unit ID mappings to other third-party systems.

List groups

Returns a list of unit reference groups for an asset.

Requires sightmap.unit-references.read permission.

NOTICE: This resource is experimental and requires the references experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the references experimental flag.

Responses

Response samples

Content type
application/json
{
  • "paging": {
    • "per_page": 100,
    • "current_page": 1,
    • "prev_url": null,
    • "next_url": null
    },
  • "data": [
    • {
      }
    ]
}

Create a group

Create a unit reference group.

Requires sightmap.unit-references.create permission.

NOTICE: This resource is experimental and requires the references experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the references experimental flag.

Request Body schema: application/json
required
asset_id
required
string <id> <= 255 characters

The asset the unit reference group belongs to.

name
required
string <= 255 characters
description
string or null <= 255 characters
key
string or null <= 255 characters ^[a-z]{1}[a-z0-9-]{1,254}$

A string used across resources to indicate the third-party system the references are part of.

The key cannot be used more than once per asset, which ensures only a single reference group may exist per asset for each key.

Responses

Request samples

Content type
application/json
{
  • "asset_id": "1323",
  • "name": "Yardi Voyager",
  • "key": "yardi-voyager"
}

Response samples

Content type
application/json
{
  • "id": "2630",
  • "asset_id": "1323",
  • "name": "Yardi Voyager",
  • "key": "yardi-voyager",
  • "created_at": "2017-09-11T17:09:17+00:00",
  • "updated_at": "2019-01-02T22:01:09+00:00"
}

View a group

Returns a specific unit reference group.

Requires sightmap.unit-references.read permission.

NOTICE: This resource is experimental and requires the references experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

group
required
string <id> <= 255 characters

A unit reference group ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the references experimental flag.

Responses

Response samples

Content type
application/json
{
  • "id": "2630",
  • "asset_id": "1323",
  • "name": "Yardi Voyager",
  • "key": "yardi-voyager",
  • "created_at": "2017-09-11T17:09:17+00:00",
  • "updated_at": "2019-01-02T22:01:09+00:00"
}

Update a group

Update a unit reference group.

Requires sightmap.unit-references.update permission.

NOTICE: This resource is experimental and requires the references experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

group
required
string <id> <= 255 characters

A unit reference group ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the references experimental flag.

Request Body schema: application/json
required
id
required
string <id> <= 255 characters
asset_id
required
string <id> <= 255 characters

The asset the unit reference group belongs to.

name
string <= 255 characters
description
string or null <= 255 characters
key
string or null <= 255 characters ^[a-z]{1}[a-z0-9-]{1,254}$

A string used across resources to indicate the third-party system the references are part of.

The key cannot be used more than once per asset, which ensures only a single reference group may exist per asset for each key.

Responses

Request samples

Content type
application/json
{
  • "id": "2630",
  • "asset_id": "1323",
  • "name": "Yardi Voyager",
  • "key": "yardi-voyager"
}

Response samples

Content type
application/json
{
  • "id": "2630",
  • "asset_id": "1323",
  • "name": "Yardi Voyager",
  • "key": "yardi-voyager",
  • "created_at": "2017-09-11T17:09:17+00:00",
  • "updated_at": "2019-01-02T22:01:09+00:00"
}

List references

Returns a list of references for a unit reference group.

Requires sightmap.unit-references.read permission.

NOTICE: This resource is experimental and requires the references experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

group
required
string <id> <= 255 characters

A unit reference group ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the references experimental flag.

Responses

Response samples

Content type
application/json
{
  • "paging": {
    • "per_page": 100,
    • "current_page": 1,
    • "prev_url": null,
    • "next_url": null
    },
  • "data": [
    • {
      }
    ]
}

Update references

Update one or more references on a unit reference group.

Requires sightmap.unit-references.update permission.

NOTICE: This resource is experimental and requires the references experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

group
required
string <id> <= 255 characters

A unit reference group ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the references experimental flag.

Request Body schema: application/json
required
Array of objects
Array
group_id
required
string <id> <= 255 characters

The group the reference belongs to.

unit_id
required
string <id> <= 255 characters

The unit the reference belongs to. A unit can only have one reference per group.

value
required
string or null <= 255 characters

The matched reference value to the unit. Must be unique amongst the group when non-null.

Responses

Request samples

Content type
application/json
{
  • "data": [
    • {
      },
    • {
      }
    ]
}

Response samples

Content type
application/json
{
  • "message": "No API key found in request"
}

Pricing & Availability

List pricing processes

Returns the pricing processes for an asset.

Requires sightmap.pricing.read permission.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

Responses

Response samples

Content type
application/json
{
  • "paging": {
    • "per_page": 100,
    • "current_page": 1,
    • "prev_url": null,
    • "next_url": null
    },
  • "data": [
    • {
      }
    ]
}

View a pricing process

Returns a specific pricing process.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

process
required
string <id> <= 255 characters

A process ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

Responses

Response samples

Content type
application/json
{
  • "id": "1145",
  • "asset_id": "1323",
  • "name": "Lofts at New Main - Manual",
  • "type": "manual",
  • "pricing_strategy": "flat_pricing",
  • "created_at": "2018-04-03T19:27:33+00:00",
  • "updated_at": "2018-04-03T19:27:33+00:00"
}

List pricing entries

Returns the pricing entries for a process. Note, there may be many entries for a unit, such is the case for revenue_management pricing strategies.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

process
required
string <id> <= 255 characters

A process ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

flat-pricing
string
Enum: "1" "0"

Force a flat pricing view of the entry data.

unit
string <id> <= 255 characters

A unit ID to filter the list on.

Responses

Response samples

Content type
application/json
{
  • "paging": {
    • "per_page": 100,
    • "current_page": 1,
    • "prev_url": null,
    • "next_url": null
    },
  • "data": [
    • [
      ]
    ]
}

List pricing units

Returns the units for a process.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

process
required
string <id> <= 255 characters

A process ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

Responses

Response samples

Content type
application/json
{
  • "paging": {
    • "per_page": 100,
    • "current_page": 1,
    • "prev_url": null,
    • "next_url": null
    },
  • "data": [
    • {
      }
    ]
}

View a pricing unit

Returns a specific unit on a process.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

process
required
string <id> <= 255 characters

A process ID.

unit
required
string <id> <= 255 characters

A unit ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

Responses

Response samples

Content type
application/json
{
  • "id": "258722",
  • "pricing_id": "1151",
  • "provider_id": "40B",
  • "unit_number": "SE40B",
  • "status": "pending",
  • "price": 2400,
  • "full_price": null,
  • "show_pricing": true,
  • "show_online_leasing": true,
  • "specials_description": null,
  • "available_on": "2018-08-28",
  • "updated_at": "2020-09-015T18:07:00+00:00",
  • "created_at": "2018-04-05T18:13:20+00:00"
}

Update a pricing unit

Requires sightmap.pricing.create-entries permission.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

process
required
string <id> <= 255 characters

A process ID.

unit
required
string <id> <= 255 characters

A unit ID.

Request Body schema: application/json
required
id
required
string <id> <= 255 characters
provider_id
string or null <id> <= 255 characters

A third-party ID matched on the unit.

status
string or null <= 255 characters

The status value on the unit.

full_price
integer or null >= 0

The full price of the unit. When this value is provided, the price attribute then represents a discounted price.

show_pricing
boolean

Determines whether prices are shown or hidden in the application for this unit.

show_online_leasing
boolean

Determines whether online leasing UI is shown or hidden in the application for this unit.

specials_description
string or null >= 512 characters

Responses

Request samples

Content type
application/json
{
  • "id": "258722",
  • "provider_id": "40B",
  • "status": "pending"
}

Response samples

Content type
application/json
{
  • "id": "258722",
  • "pricing_id": "1151",
  • "provider_id": "40B",
  • "unit_number": "SE40B",
  • "status": "pending",
  • "price": 2400,
  • "full_price": null,
  • "show_pricing": true,
  • "show_online_leasing": true,
  • "specials_description": null,
  • "available_on": "2018-08-28",
  • "updated_at": "2020-09-015T18:07:00+00:00",
  • "created_at": "2018-04-05T18:13:20+00:00"
}

Expenses

List asset expenses

Returns a list of asset level expenses for the asset.

Requires sightmap.expenses.read permission.

NOTICE: This resource is experimental and requires the expenses experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the expenses experimental flag.

Responses

Response samples

Content type
application/json
{
  • "paging": {
    • "per_page": 100,
    • "current_page": 1,
    • "prev_url": null,
    • "next_url": null
    },
  • "data": [
    • {
      },
    • {
      }
    ]
}

Create an asset expense

Create an asset level expense for an asset.

Requires sightmap.expenses.create permission.

NOTICE: This resource is experimental and requires the expenses experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the expenses experimental flag.

Request Body schema: application/json
required
One of
asset_id
required
string <id> <= 255 characters

The asset the expense belongs to.

label
required
string <= 50 characters
type
required
string
Enum: "administrative_fee" "application_fee" "base_rent" "cleaning_fee" "community_fee" "insurance" "locker_rental" "move_in_fee" "move_out_fee" "parking_spot" "pest_control" "pet_deposit" "pet_rent" "pet_screening" "security_deposit" "storage_space" "utility_cable" "utility_electricity" "utility_gas" "utility_general" "utility_trash" "utility_water" "utility_wifi"
category
required
string or null
Enum: "contract_fees" "parking_fees" "pet_fees" "rentable_items" "utilities"
frequency
required
string
Enum: "one_time" "monthly" "annually"
value_type
required
string
Enum: "amount" "range" "text"
  • amount: A single number value.
  • range: A minimum and maximum number value.
  • text: A string which cannot be calculated on and only displayed.
amount
required
number

The specific amount of the expense.

is_required
boolean
Default: false

Determines if the expense must be paid.

is_enabled
boolean
Default: false

Determines whether or not the expense is enabled.

Responses

Request samples

Content type
application/json
Example
{
  • "asset_id": "1323",
  • "label": "Application Fee",
  • "type": "application_fee",
  • "category": "contract_fees",
  • "frequency": "one_time",
  • "value_type": "amount",
  • "amount": 50,
  • "is_required": true,
  • "is_enabled": true
}

Response samples

Content type
application/json
Example
{
  • "id": "1",
  • "asset_id": "1323",
  • "label": "Application Fee",
  • "type": "application_fee",
  • "category": "contract_fees",
  • "frequency": "one_time",
  • "value_type": "amount",
  • "amount": 50,
  • "is_required": true,
  • "is_enabled": true,
  • "created_at": "2024-07-11T17:09:17+00:00",
  • "updated_at": "2024-07-13T14:07:13+00:00"
}

View an asset expense

Returns a specific asset level expense for the asset.

Requires sightmap.expenses.read permission.

NOTICE: This resource is experimental and requires the expenses experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

expense
required
string <id> <= 255 characters

An expense ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the expenses experimental flag.

Responses

Response samples

Content type
application/json
Example
{
  • "id": "1",
  • "asset_id": "1323",
  • "label": "Application Fee",
  • "type": "application_fee",
  • "category": "contract_fees",
  • "frequency": "one_time",
  • "value_type": "amount",
  • "amount": 50,
  • "is_required": true,
  • "is_enabled": true,
  • "created_at": "2024-07-11T17:09:17+00:00",
  • "updated_at": "2024-07-13T14:07:13+00:00"
}

Update an asset expense

Update an asset level expense for an asset.

Requires sightmap.expenses.update permission.

NOTICE: This resource is experimental and requires the expenses experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

expense
required
string <id> <= 255 characters

An expense ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the expenses experimental flag.

Request Body schema: application/json
required
One of
id
required
string <id> <= 255 characters
asset_id
required
string <id> <= 255 characters

The asset the expense belongs to.

label
string <= 50 characters
type
string
Enum: "administrative_fee" "application_fee" "base_rent" "cleaning_fee" "community_fee" "insurance" "locker_rental" "move_in_fee" "move_out_fee" "parking_spot" "pest_control" "pet_deposit" "pet_rent" "pet_screening" "security_deposit" "storage_space" "utility_cable" "utility_electricity" "utility_gas" "utility_general" "utility_trash" "utility_water" "utility_wifi"
category
string or null
Enum: "contract_fees" "parking_fees" "pet_fees" "rentable_items" "utilities"
frequency
string
Enum: "one_time" "monthly" "annually"
value_type
string
Enum: "amount" "range" "text"
  • amount: A single number value.
  • range: A minimum and maximum number value.
  • text: A string which cannot be calculated on and only displayed.
amount
number

The specific amount of the expense.

Required if the value type is changed to amount.

is_required
boolean

Determines if the expense must be paid.

is_enabled
boolean

Determines whether or not the expense is enabled.

Responses

Request samples

Content type
application/json
Example
{
  • "id": "1",
  • "asset_id": "1323",
  • "label": "Application Fee",
  • "type": "application_fee",
  • "category": "contract_fees",
  • "frequency": "one_time",
  • "value_type": "amount",
  • "amount": 50,
  • "is_required": true,
  • "is_enabled": true
}

Response samples

Content type
application/json
Example
{
  • "id": "1",
  • "asset_id": "1323",
  • "label": "Application Fee",
  • "type": "application_fee",
  • "category": "contract_fees",
  • "frequency": "one_time",
  • "value_type": "amount",
  • "amount": 50,
  • "is_required": true,
  • "is_enabled": true,
  • "created_at": "2024-07-11T17:09:17+00:00",
  • "updated_at": "2024-07-13T14:07:13+00:00"
}

Delete an asset expense

Requires sightmap.expenses.delete permission.

NOTICE: This resource is experimental and requires the expenses experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

expense
required
string <id> <= 255 characters

An expense ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the expenses experimental flag.

Responses

Response samples

Content type
application/json
Example
{
  • "id": "1",
  • "asset_id": "1323",
  • "label": "Application Fee",
  • "type": "application_fee",
  • "category": "contract_fees",
  • "frequency": "one_time",
  • "value_type": "amount",
  • "amount": 50,
  • "is_required": true,
  • "is_enabled": true,
  • "created_at": "2024-07-11T17:09:17+00:00",
  • "updated_at": "2024-07-13T14:07:13+00:00"
}

List floor plan expenses

Returns a list of floor plan level expenses for the asset.

Requires sightmap.expenses.read permission.

NOTICE: This resource is experimental and requires the expenses experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the expenses experimental flag.

Responses

Response samples

Content type
application/json
{
  • "paging": {
    • "per_page": 100,
    • "current_page": 1,
    • "prev_url": null,
    • "next_url": null
    },
  • "data": [
    • {
      },
    • {
      }
    ]
}

Create a floor plan expense

Create an floor plan level expense for an asset.

Requires sightmap.expenses.create permission.

NOTICE: This resource is experimental and requires the expenses experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the expenses experimental flag.

Request Body schema: application/json
required
asset_id
required
string <id> <= 255 characters

The asset the expense belongs to.

label
required
string <= 50 characters
type
required
string
Enum: "administrative_fee" "application_fee" "base_rent" "cleaning_fee" "community_fee" "insurance" "locker_rental" "move_in_fee" "move_out_fee" "parking_spot" "pest_control" "pet_deposit" "pet_rent" "pet_screening" "security_deposit" "storage_space" "utility_cable" "utility_electricity" "utility_gas" "utility_general" "utility_trash" "utility_water" "utility_wifi"
category
required
string or null
Enum: "contract_fees" "parking_fees" "pet_fees" "rentable_items" "utilities"
frequency
required
string
Enum: "one_time" "monthly" "annually"
value_type
required
string
Enum: "amount" "range" "text"
  • amount: A single number value.
  • range: A minimum and maximum number value.
  • text: A string which cannot be calculated on and only displayed.
is_required
boolean
Default: false

Determines if the expense must be paid.

is_enabled
boolean
Default: false

Determines whether or not the expense is enabled.

Responses

Request samples

Content type
application/json
{
  • "asset_id": "1323",
  • "label": "Application Fee",
  • "type": "application_fee",
  • "category": "contract_fees",
  • "frequency": "one_time",
  • "value_type": "amount",
  • "is_required": true,
  • "is_enabled": true
}

Response samples

Content type
application/json
{
  • "id": "1",
  • "asset_id": "1323",
  • "label": "Application Fee",
  • "type": "application_fee",
  • "category": "contract_fees",
  • "frequency": "one_time",
  • "value_type": "amount",
  • "is_required": true,
  • "is_enabled": true,
  • "created_at": "2024-07-11T17:09:17+00:00",
  • "updated_at": "2024-07-13T14:07:13+00:00"
}

View a floor plan expense

Returns a specific floor plan level expense for the asset.

Requires sightmap.expenses.read permission.

NOTICE: This resource is experimental and requires the expenses experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

expense
required
string <id> <= 255 characters

An expense ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the expenses experimental flag.

Responses

Response samples

Content type
application/json
{
  • "id": "1",
  • "asset_id": "1323",
  • "label": "Application Fee",
  • "type": "application_fee",
  • "category": "contract_fees",
  • "frequency": "one_time",
  • "value_type": "amount",
  • "is_required": true,
  • "is_enabled": true,
  • "created_at": "2024-07-11T17:09:17+00:00",
  • "updated_at": "2024-07-13T14:07:13+00:00"
}

Update a floor plan expense

Update a floor plan level expense for an asset.

Requires sightmap.expenses.update permission.

NOTICE: This resource is experimental and requires the expenses experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

expense
required
string <id> <= 255 characters

An expense ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the expenses experimental flag.

Request Body schema: application/json
required
id
required
string <id> <= 255 characters
asset_id
required
string <id> <= 255 characters

The asset the expense belongs to.

label
string <= 50 characters
type
string
Enum: "administrative_fee" "application_fee" "base_rent" "cleaning_fee" "community_fee" "insurance" "locker_rental" "move_in_fee" "move_out_fee" "parking_spot" "pest_control" "pet_deposit" "pet_rent" "pet_screening" "security_deposit" "storage_space" "utility_cable" "utility_electricity" "utility_gas" "utility_general" "utility_trash" "utility_water" "utility_wifi"
category
string or null
Enum: "contract_fees" "parking_fees" "pet_fees" "rentable_items" "utilities"
frequency
string
Enum: "one_time" "monthly" "annually"
value_type
string
Enum: "amount" "range" "text"
  • amount: A single number value.
  • range: A minimum and maximum number value.
  • text: A string which cannot be calculated on and only displayed.

Warning: If this field is changed - all existing entries will be wiped.

is_required
boolean

Determines if the expense must be paid.

is_enabled
boolean

Determines whether or not the expense is enabled.

Responses

Request samples

Content type
application/json
{
  • "id": "1",
  • "asset_id": "1323",
  • "label": "Application Fee",
  • "type": "application_fee",
  • "category": "contract_fees",
  • "frequency": "one_time",
  • "value_type": "amount",
  • "is_required": true,
  • "is_enabled": true
}

Response samples

Content type
application/json
{
  • "id": "1",
  • "asset_id": "1323",
  • "label": "Application Fee",
  • "type": "application_fee",
  • "category": "contract_fees",
  • "frequency": "one_time",
  • "value_type": "amount",
  • "is_required": true,
  • "is_enabled": true,
  • "created_at": "2024-07-11T17:09:17+00:00",
  • "updated_at": "2024-07-13T14:07:13+00:00"
}

Delete a floor plan expense

Requires sightmap.expenses.delete permission.

NOTICE: This resource is experimental and requires the expenses experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

expense
required
string <id> <= 255 characters

An expense ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the expenses experimental flag.

Responses

Response samples

Content type
application/json
{
  • "id": "1",
  • "asset_id": "1323",
  • "label": "Application Fee",
  • "type": "application_fee",
  • "category": "contract_fees",
  • "frequency": "one_time",
  • "value_type": "amount",
  • "is_required": true,
  • "is_enabled": true,
  • "created_at": "2024-07-11T17:09:17+00:00",
  • "updated_at": "2024-07-13T14:07:13+00:00"
}

List floor plan expense entries

Returns the entries for a floor plan level expense.

Requires sightmap.expenses.read permission.

NOTICE: This resource is experimental and requires the expenses experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

expense
required
string <id> <= 255 characters

An expense ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the expenses experimental flag.

Responses

Response samples

Content type
application/json
{
  • "paging": {
    • "per_page": 100,
    • "current_page": 1,
    • "prev_url": null,
    • "next_url": null
    },
  • "data": [
    • {
      }
    ]
}

Update floor plan expense entries

Update one or more entries for a floor plan level expense.

Requires sightmap.expenses.update permission.

NOTICE: This resource is experimental and requires the expenses experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

expense
required
string <id> <= 255 characters

An expense ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the expenses experimental flag.

Request Body schema: application/json
required
One of
Array of objects
Array
asset_id
required
string <id> <= 255 characters

The asset the entry belongs to.

expense_id
required
string <id> <= 255 characters

The expense the entry belongs to.

floor_plan_id
required
string <id> <= 255 characters

The floor plan the entry belongs to.

amount
required
number

The specific amount of the expense on the floor plan.

Responses

Request samples

Content type
application/json
Example
{
  • "data": [
    • {
      },
    • {
      }
    ]
}

Response samples

Content type
application/json
{
  • "message": "No API key found in request"
}

Delete a floor plan expense entry

Requires sightmap.expenses.delete permission.

NOTICE: This resource is experimental and requires the expenses experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

expense
required
string <id> <= 255 characters

An expense ID.

floor-plan
required
string <id> <= 255 characters

A Floor Plan ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the expenses experimental flag.

Responses

Response samples

Content type
application/json
Example
{
  • "asset_id": "1323",
  • "expense_id": "1",
  • "floor_plan_id": "14641",
  • "amount": 50
}

List unit expenses

Returns a list of unit level expenses for the asset.

Requires sightmap.expenses.read permission.

NOTICE: This resource is experimental and requires the expenses experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the expenses experimental flag.

Responses

Response samples

Content type
application/json
{
  • "paging": {
    • "per_page": 100,
    • "current_page": 1,
    • "prev_url": null,
    • "next_url": null
    },
  • "data": [
    • {
      },
    • {
      }
    ]
}

Create a unit expense

Create a unit level expense for an asset.

Requires sightmap.expenses.create permission.

NOTICE: This resource is experimental and requires the expenses experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the expenses experimental flag.

Request Body schema: application/json
required
asset_id
required
string <id> <= 255 characters

The asset the expense belongs to.

label
required
string <= 50 characters
type
required
string
Enum: "administrative_fee" "application_fee" "base_rent" "cleaning_fee" "community_fee" "insurance" "locker_rental" "move_in_fee" "move_out_fee" "parking_spot" "pest_control" "pet_deposit" "pet_rent" "pet_screening" "security_deposit" "storage_space" "utility_cable" "utility_electricity" "utility_gas" "utility_general" "utility_trash" "utility_water" "utility_wifi"
category
required
string or null
Enum: "contract_fees" "parking_fees" "pet_fees" "rentable_items" "utilities"
frequency
required
string
Enum: "one_time" "monthly" "annually"
value_type
required
string
Enum: "amount" "range" "text"
  • amount: A single number value.
  • range: A minimum and maximum number value.
  • text: A string which cannot be calculated on and only displayed.
is_required
boolean
Default: false

Determines if the expense must be paid.

is_enabled
boolean
Default: false

Determines whether or not the expense is enabled.

Responses

Request samples

Content type
application/json
{
  • "asset_id": "1323",
  • "label": "Application Fee",
  • "type": "application_fee",
  • "category": "contract_fees",
  • "frequency": "one_time",
  • "value_type": "amount",
  • "is_required": true,
  • "is_enabled": true
}

Response samples

Content type
application/json
{
  • "id": "1",
  • "asset_id": "1323",
  • "label": "Application Fee",
  • "type": "application_fee",
  • "category": "contract_fees",
  • "frequency": "one_time",
  • "value_type": "amount",
  • "is_required": true,
  • "is_enabled": true,
  • "created_at": "2024-07-11T17:09:17+00:00",
  • "updated_at": "2024-07-13T14:07:13+00:00"
}

View a unit expense

Returns a specific unit level expense for the asset.

Requires sightmap.expenses.read permission.

NOTICE: This resource is experimental and requires the expenses experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

expense
required
string <id> <= 255 characters

An expense ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the expenses experimental flag.

Responses

Response samples

Content type
application/json
{
  • "id": "1",
  • "asset_id": "1323",
  • "label": "Application Fee",
  • "type": "application_fee",
  • "category": "contract_fees",
  • "frequency": "one_time",
  • "value_type": "amount",
  • "is_required": true,
  • "is_enabled": true,
  • "created_at": "2024-07-11T17:09:17+00:00",
  • "updated_at": "2024-07-13T14:07:13+00:00"
}

Update a unit expense

Update a unit level expense for an asset.

Requires sightmap.expenses.update permission.

NOTICE: This resource is experimental and requires the expenses experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

expense
required
string <id> <= 255 characters

An expense ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the expenses experimental flag.

Request Body schema: application/json
required
id
required
string <id> <= 255 characters
asset_id
required
string <id> <= 255 characters

The asset the expense belongs to.

label
string <= 50 characters
type
string
Enum: "administrative_fee" "application_fee" "base_rent" "cleaning_fee" "community_fee" "insurance" "locker_rental" "move_in_fee" "move_out_fee" "parking_spot" "pest_control" "pet_deposit" "pet_rent" "pet_screening" "security_deposit" "storage_space" "utility_cable" "utility_electricity" "utility_gas" "utility_general" "utility_trash" "utility_water" "utility_wifi"
category
string or null
Enum: "contract_fees" "parking_fees" "pet_fees" "rentable_items" "utilities"
frequency
string
Enum: "one_time" "monthly" "annually"
value_type
string
Enum: "amount" "range" "text"
  • amount: A single number value.
  • range: A minimum and maximum number value.
  • text: A string which cannot be calculated on and only displayed.

Warning: If this field is changed - all existing entries will be wiped.

is_required
boolean

Determines if the expense must be paid.

is_enabled
boolean

Determines whether or not the expense is enabled.

Responses

Request samples

Content type
application/json
{
  • "id": "1",
  • "asset_id": "1323",
  • "label": "Application Fee",
  • "type": "application_fee",
  • "category": "contract_fees",
  • "frequency": "one_time",
  • "value_type": "amount",
  • "is_required": true,
  • "is_enabled": true
}

Response samples

Content type
application/json
{
  • "id": "1",
  • "asset_id": "1323",
  • "label": "Application Fee",
  • "type": "application_fee",
  • "category": "contract_fees",
  • "frequency": "one_time",
  • "value_type": "amount",
  • "is_required": true,
  • "is_enabled": true,
  • "created_at": "2024-07-11T17:09:17+00:00",
  • "updated_at": "2024-07-13T14:07:13+00:00"
}

Delete a unit expense

Requires sightmap.expenses.delete permission.

NOTICE: This resource is experimental and requires the expenses experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

expense
required
string <id> <= 255 characters

An expense ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the expenses experimental flag.

Responses

Response samples

Content type
application/json
{
  • "id": "1",
  • "asset_id": "1323",
  • "label": "Application Fee",
  • "type": "application_fee",
  • "category": "contract_fees",
  • "frequency": "one_time",
  • "value_type": "amount",
  • "is_required": true,
  • "is_enabled": true,
  • "created_at": "2024-07-11T17:09:17+00:00",
  • "updated_at": "2024-07-13T14:07:13+00:00"
}

List unit expense entries

Returns the entries for a unit level expense.

Requires sightmap.expenses.read permission.

NOTICE: This resource is experimental and requires the expenses experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

expense
required
string <id> <= 255 characters

An expense ID.

query Parameters
page
integer <int32>

Request a specific page of resources.

per-page
integer <int32>

Limit the number of returned resources.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the expenses experimental flag.

Responses

Response samples

Content type
application/json
{
  • "paging": {
    • "per_page": 100,
    • "current_page": 1,
    • "prev_url": null,
    • "next_url": null
    },
  • "data": [
    • {
      }
    ]
}

Update unit expense entries

Update one or more entries for a unit level expense.

Requires sightmap.expenses.update permission.

NOTICE: This resource is experimental and requires the expenses experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

expense
required
string <id> <= 255 characters

An expense ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the expenses experimental flag.

Request Body schema: application/json
required
One of
Array of objects
Array
asset_id
required
string <id> <= 255 characters

The asset the entry belongs to.

expense_id
required
string <id> <= 255 characters

The expense the entry belongs to.

unit_id
required
string <id> <= 255 characters

The unit the entry belongs to.

amount
required
number

The specific amount of the expense on the unit.

Responses

Request samples

Content type
application/json
Example
{
  • "data": [
    • {
      },
    • {
      }
    ]
}

Response samples

Content type
application/json
{
  • "message": "No API key found in request"
}

Delete a unit expense entry

Requires sightmap.expenses.delete permission.

NOTICE: This resource is experimental and requires the expenses experimental flag.

Authorizations:
API Key
path Parameters
asset
required
string <id> <= 255 characters

An asset ID.

expense
required
string <id> <= 255 characters

An expense ID.

unit
required
string <id> <= 255 characters

A Unit ID.

header Parameters
Experimental-Flags
required
string

This resource is experimental and requires the expenses experimental flag.

Responses

Response samples

Content type
application/json
Example
{
  • "asset_id": "1323",
  • "expense_id": "1",
  • "unit_id": "258670",
  • "amount": 50
}