Marketing Export

Introduction

This is the central repository for information on exporting marketing data tied to your buildings and available spaces from VTS. On this page, you will find a sample of our JSON formatting; a list of elements with description, parameters; and tutorials to help you get started with an API integration.

To start using the VTS Marketing API, the API consumer must have an API key and an API secret to authenticate requests. VTS will provide these credentials to authorized API consumers. If you would like to test whether your credentials are valid, please refer to the Authentication section.

Requests

The API can be accessed by sending an HTTP request to https://api.vts.com/api/marketing/v1/properties with the Authorization header described in the Authentication section (also shown below)

curl -u <API_KEY>:<API_SECRET> "https://api.vts.com/api/marketing/v1/properties"

curl -u <API_KEY>:<API_SECRET> "https://api.vts.com/api/marketing/v1/properties/{vts_property_id}"

curl -u <API_KEY>:<API_SECRET> "https://sandbox.vts.com/api/marketing/v1/properties"

📘
Make sure to replace <API Key> and <API Secret> with your API key and API Secret, respectively.

Request Parameters

The following parameters can be used to request smaller amounts of data.

Note: You may specify a property ID at the end of the URL to request data for one property. Syntax for this request is shown in the "By Property ID" tab in the above code sample.

Parameter	Description
page	The response will specify how many total pages there are - by default the JSON will return with only the first page. You can specify the page number by entering any integer within the total pages (i.e. if there are 16 pages the parameter cannot be more than 'page=16')

Status Codes

Status	Description
200	Success – The request was successful
202	Accepted – The request was accepted and will be processed
401	Unauthorized - incorrect credentials
403	Forbidden – API Key and/or API Secret is missing or incorrect
404	Not Found – The specified resource could not be found
500	Internal Server Error – We had a problem with our server and have been notified. Try again later

Marketing Elements

Properties

Node	Type	Definition	Example
id	integer	Unique ID of the property in VTS	1
building_class	enum	Indicates the property’s class: A, B, C	A
country	string	The property's two-letter country code (ISO31661 alpha2)	United States
custom_flyer_url	string	The URL destination of a property's flyer that has been uploaded to VTS	https://app.vts.com/properties/1/custom_flyers/1
description	string	Text description of the property	Tower A Midtown Manhattan
has_industrial_space	boolean	Flags if the property includes industrial space	false
has_office_space	boolean	Flags if the property includes office space	true
has_retail_space	boolean	Flags if the property includes retail space	false
lease_roll	integer	Sum total of Lease RSF expiring as part of 18 mo. lease roll.	9500
name	string	Name of the property	Tower A
occupied_square_feet	integer	Sum of occupied space area in the property	8000
rba	integer	Area of the property	100000
sourceid	integer	Ties a property's unique identifier from an ERP system to VTS. Note: this is only applicable if the client has an ERP system integration with VTS.	towera
space_available	integer	Space available to rent	20000
state	string	Abbreviation of the state that the property is located in	NY
street_address	string	Street number and street name that the property is located on	1 Manhattan Street
submarket	string	Name of the submarket that the property is located in	Midtown
tokenized_id	string	A concatenation of several values that comprise a unique text identifier	TowerA~NYC
vacancy_rate	decimal	Vacancy rate for the building (Sum of vacant spaces in the property divided by the RBA)	0.2
year_built	string	The year the property was built	1900
year_renovated	string	The year the property was renovated	2010
zip_code	string	The postal code of the property	11111
listing_status	enum	The listing status of the asset on VTS Market	on_market

City

Nested under property

Node	Type	Description	Example
name	string	Name of the city that the property is in	New York

Markets

Nested under city

Node	Type	Description	Example
id	string	unique identifier	123
name	string	name of the market that the property is in	true
default	boolean	Whether the market is a VTS default or not	true

Photos

Nested under property or spaces

Node	Type	Description	Example
url	string	The URL destination of a property or space photo that has been uploaded to VTS.	https://images.vts.com/view-the-space/image/upload/v14/floor-plan.jpg

Contact Users

Nested under property and spaces

Node	Type	Description	Example
id	string	unique identifier of the user	123
email	string	Email address of the contact	[email protected]
first_name	string	First name of the contact	John
last_name	string	Last name of the contact	Smith
phone	string	Phone number of the contact	9999999999

Spaces

Nested under property

Node	Type	Description	Example
id	integer	The unique identifier for the space	1
availability_date	date	If `availability_type` is set to 'specified', then this returns the date on which the space will be available. Otherwise, this returns NULL.	2022-01-01
industry	string
is_hypothetical	boolean	Returns "TRUE" if the specified space is a hypothetical space	TRUE
availability_type	enum	Whether the space is available as the following values: ‘specified’, ‘arranged’, ‘immediate’, ‘not available’, ‘month-to-month’	arranged
custom_flyer_url	string	URL of the marketing flyer for this space	https://app.vts.com/spaces/1/custom_flyers/1
description	string	Description of the space	Suite 200 of Midtown Manhattan Building
floor_composition	enum	‘entire’, ‘partial’	entire
lease_term	string	Requested/desired length of lease	Negotiable
lease_type	enum	Requested/desired lease type: ‘renewal’, ‘sublease’, ‘direct’. Defaults to ‘direct’. Note: this field is a legacy field and is no longer editable via the application	direct
listing_url	string	This represents the url of the VTS Market listing (includes listing UTM code to enable tracking/analytics)	https://marketplace.vts.com/listing/b3e791cb-eea6-42df-8b4c-c13dc36ed5f3
listing_3d_tour_url	string	The URL of the 3D tour for this VTS Market listing	https://marketplace.vts.com/listing/b3e791cb-eea6-42df-8b4c-c13dc36ed5f3/3dtour
listing_floor_plan_url	string	The floor plan as uploaded to the VTS Market listing	https://marketplace.vts.com/listing/b3e791cb-eea6-42df-8b4c-c13dc36ed5f3/floor_plans
listing_virtual_tour_url	string	The URL of the virtual tour for this VTS Market listing	https://marketplace.vts.com/listing/b3e791cb-eea6-42df-8b4c-c13dc36ed5f3/virtual_tour
maximum_contiguous	integer	The maximum area to which a space can be expanded	5000
minimum_divisible	integer	The minimum size that can be rented out of the space’s total area	1250
occupancy_status	enum	'vacant', 'occupied'	vacant
price_is_negotiable	boolean	Indicates if the price can be negotiated	true
public	boolean	If true, the space will display on the VTS public marketing pages	false
remeasured_space_available	integer	The listing size of a space	11000
rental_rate_max	decimal	Highest asking rent	1000.00
rental_rate_min	decimal	Lowest asking rent	1000.00
sale_price	decimal	Asking price for the space	45000
sourceid	string	Ties a space’s unique identifier from the ERP system to VTS	TowerA~200~3
space_available	integer	Area available to rent in the space	1000
space_condition	enum	Physical condition of the space. Can be: '2nd generation' 'category a' 'category b' 'challenged' 'core and shell' 'fitted out' 'floor and shell' 'plug & play' 'pre-built' 'pre-existing' 'raw' 'turnkey' 'under construction' 'un-refurbished' 'white box'	raw
space_type	enum	'Industrial / Warehouse' 'Flex' 'Lab' 'Amenities' 'Office' 'Parking' 'Retail' 'Rooftop' 'Storage' 'Telecom' 'Other' 'Manufacturing' 'Residential' 'Medical Office'	office
subtitle	string	Secondary description of a space	First floor space for a doctor’s office
suite	string	The name of the space in VTS	200
suite_display_name	string	The suite name as shown in the VTS Market listing. This may be different than the Suite name in VTS Lease.	Suite #200
tokenized_id	string	A concatenation of several values that comprise a unique text identifier	TowerA-Manhattan-Street-2nd-floor-suite-200
transaction_type	enum	'lease', 'sale'	lease
rental_pay_type	enum	Unit of measure for rental_rate_max and rental_rate_min fields. 'psf_month', 'psf_year', 'amt_month', 'amt_year'	psf_year
updated_at	datetime	The date and time that the space was last updated	2017-05-16T22:33:28Z
listing_status	enum	The listing status of the space on VTS Market	live

Floor

Nested under space

Node	Type	Description	Example
name	string	Name of the floor in VTS	2
position	integer	The sort order of the floor within a given building. This field is used to generate the VTS stacking plan.	3
rentable_area	integer	Rentable are of the floor	12000

Space Details

Nested under space

Node	Type	Description	Example
id	integer
hvac	string
parking	string
electrical	string
column_spacing	string
depth	string
dock_high	string
office_portion	string
trailer_parking	string
ceiling_height	string
space_id	integer
created_at	datetime
updated_at	datetime
sprinklers	string
roof	string
clear_height	string
ground_level_doors	string
yard	string

Floor Plan Photos

Nested under space

Node	Type	Description	Example
url	string	The url destination for the floor plan uploaded to VTS	https://images.vts.com/view-the-space/image/upload/v14/floor-plan.jpg

Office Parks

Nested under property

Node	Type	Description	Example
id	integer	Unique ID of the office park in VTS	1201
name	string	The name of the office park	Midtown Lot I
sourceid	string	Ties an office park’s unique identifier from the ERP system to VTS	Midtown~Lot~I

Sample Response

{
  "page": 1,
  "total_pages": 1,
  "properties": [
    {
      "building_class": "A",
      "country": "US",
      "custom_flyer_url": "https://vts.com/properties/1/custom_flyers/1",
      "description": "Tower A Midtown Manhattan",
      "has_industrial_space": false,
      "has_office_space": true,
      "has_retail_space": false,
      "id": 1,
      "lease_roll": 9500,
      "name": "Tower A",
      "occupied_square_feet": 80000,
      "rba": 100000,
      "sourceid": "towera",
      "space_available": 20000,
      "state": "NY",
      "street_address": " 1 Manhattan Street",
      "submarket": "Midtown",
      "tokenized_id": "TowerA~NYC",
      "vacancy_rate": 0.2,
      "vacant_square_feet": 20000,
      "videos": [
        {
          "video_still_url": "images.vts.com/efg/1",
         "video_type": "lobby"
        }
      ],
      "year_built": "1900",
      "year_renovated": "2010",
      "zip_code": "11111",
      "city": {
        "name": "New York",
        "markets": [
          {
            "name": "new york",
            "default": false
          },
          {
            "name": "northeast",
            "default": true
          }
        ]
      },
      "photos": [
      ],
      "contact_users": [
        {
          "email": "[email protected]",
          "first_name": "John",
          "last_name": "Smith",
          "phone": "9999999999"
        }
      ],
      "spaces": [
        {
          "availability_date": "2015-01-01",
          "availability_type": "not available",
          "custom_flyer_url": "https://vts.com/spaces/1/custom_flyers/1",
          "description": "Suite 200 of Midtown Manhattan Building",
          "floor": {
            "name": "2",
            "position": 3,
            "rentable_area": 12000
          },
          "floor_composition": "entire",
          "id": 1,
          "lease_term": "Negotiable",
          "lease_type": "direct",
          "maximum_contiguous": "8",
          "minimum_divisible": null,
          "occupancy_status": "vacant",
          "price_is_negotiable": true,
          "public": false,
          "remeasured_space_available": 11000,
          "rental_rate_max": 1000,
          "rental_rate_min": 3000,
          "sale_price": 45000,
          "sourceid": "TowerA~200~3",
          "space_available": 10000,
          "space_condition": null,
          "space_type": "office",
          "subtitle": null,
          "suite": "200",
          "tokenized_id": "TowerA-Manhattan-Street-2nd-floor-suite-200",
          "transaction_type": "lease",
          "videos": [],
          "rental_pay_type": "psf_year",
          "updated_at": "2017-05-16T22:33:28Z",
          "contact_users": [
            {
              "email": "[email protected]",
              "first_name": "John",
              "last_name": "Smith",
              "phone": "9999999999"
            }
          ],
          "photos": [
            {
              "url": "https://images.vts.com/view-the-space/image/upload/v14/floor-plan.jpg"
            }
          ],
          "floor_plan_photos": [
            {
              "url": "https://images.vts.com/view-the-space/image/upload/v14/floor-plan.jpg"
            }
          ]
        }
      ],
      "office_park": {
        "name": "Midtown Lot I",
        "sourceid": "Midtown~Lot~I",
        "id": "1201"
      }
    }
  ]
}

This document is proprietary and confidential. No part of this document may be disclosed in any manner to a third party without the prior written consent of View the Space Inc.