Overview

We're continuing our endeavor to export Account Administration settings. The Task Settings and Task Templates endpoints allow account administrators to review a list of task settings and the deal and space types they're associated with as well as metadata and conditions that apply to those tasks.

The Asset Groups endpoint allows account administrators to retrieve Asset groupings and link them to task settings that are set up for that asset group.

Additionally, some of these Account Admin paths have changed to make them easier to find. Please see the callout below.

New API Features

📘

New Account Admin Group

Since we'll be expanding our Account Admin endpoints, we've added the endpoints from this update and the previous update to a new Account Admin group.

The Asset Permissions path can now be found at /api/v1/account_admin/user_asset_permissions

The User Permissions path can now be found at
/api/v1/account_admin/user_space_permissions

While the path has changed, the shape of the response has not changed.

Task Settings

A new path to /api/v1/account_admin/task_settings includes the following attributes and relationships:

  • Name
  • deal_types(list will be empty if "any" is selected)
  • space_types(list will be empty if "any" is selected)
  • a link to asset_groups
  • a link to task_templates

Task Templates

A new path to /api/v1/account_admin/task_settings includes the following attributes and relationships:

  • Name
  • deal_stage
  • order_number
  • required
  • a link to assignee
  • a link to task_setting

Asset Groups

A new path to /api/v1/account_admin/asset_groups includes the following attributes and relationships:

  • Name
  • a link to assets object
  • a link to task_settingobject

Upcoming

Our next set of Next Gen API enhancements will include the following updates:

  • Additional enhancements for account administrators to retrieve Approval Settings

API Updates

Overview

We're expanding into account administration! VTS' APIs will now include a new path to retrieve account administration settings. With this change, account administrators will be able to audit user permissions for space and assets. These have been added to the Assets and Spaces endpoints, respectively.

New API Features

Assets

A new path to api/v1/user_asset_permissions includes the following attributes and relationships:

  • permission (e.g. "Availabilities & Existing")
  • user_email
  • asset_address
  • a link to asset
  • a link to user
The asset info and column headers available for the user_asset_permissions path

The asset info and column headers available for the user_asset_permissions path

Spaces

A new path to api/v1/user_space_permissions includes the following attributes and relationships:

  • permission (e.g. "Availabilities & Existing")
  • team_override
  • user_email
  • asset_address
  • suite_name
  • a link to asset
  • a link to space
  • a link to user
The space info and column headers available for the user_space_permissions path

The space info and column headers available for the user_space_permissions path

Upcoming

Our next set of Next Gen API enhancements will include the following updates:

  • Additional enhancements for account administrators to retrieve Task Settings and Asset Groups
  • Additional enhancements for Assets related to default settings

API Updates

Overview

The Coordination Projects endpoint has new fields and relationships to build a more holistic view of Tenant Coordination milestones and related entities.

New API Features

Tenant Coordination Endpoint

The coordination_project_milestones path now includes a link to the coordination_project

The coordination_projects path now includes:

  • status
  • a link to tenant
  • a link to deals
  • a link to asset
  • a link to next_milestone
The fields above can be accessed from the coordination_projects path

The fields above can be accessed from the coordination_projects path*

*The link to deals appears as a Space name but links users to the Deals page. The above screenshot is meant to map front-end elements to the API endpoints. In this case, if a user would like to retrieve the page seen from clicking on the space name, they can utilize the link to deals in the coordination_projects path

Upcoming

Our next set up Next Gen API enhancements will include the following updates:

  • Enhancements to the Asset endpoint for default deal settings

API Updates

Overview

The Proposal endpoint has a new object total_escalated_rent_before_abatementto capture the value of a base rent proposal including rent escalations but before any abatements or added.

New API Features

In Proposals, the new total_escalated_rent_before_abatement object represents the total base rent before abatement over the lifetime of the lease which includes the sum of Base Rent + Rent Escalation. See screenshot below to see where this value can be found in the front-end user interface (Deals > Deal Profile > Proposals > Cash Flow)

The new object returns Base Rent from the Total column, highlighted by the orange box

The new object returns Base Rent from the Total column, highlighted by the orange box

🚧

Deprecation Notice

The total_base_rent object in the Proposals endpoint has been deprecated to avoid confusion and breaking changes.

This object represents the sum of abated Base Rent and abated Rent Escalations.

Upcoming

Our next set up Next Gen API enhancements will include the following updates:

  • Enhancements to the Tenant Coordination endpoint
  • Enhancements to the Asset endpoint for default deal settings
  • A new endpoint for retrieving Access Management settings

API Updates

Overview

The Coordination Projects endpoint has a new path to retrieve a list of all milestones without the Project ID parameter.

New API Features

In Tenant Coordination, a new route https://api.vts.com/api/v1/coordination_project_milestones will provide milestones without the project_id parameter

Upcoming

Our next set up Next Gen API enhancements will include the following updates:

  • Enhancements to the Tenant Coordination endpoint

API Updates

Overview

The Tenant endpoint has a new fields added for Relationship Owners

New API Features

In Tenant , added a new relationship to expose relationship_owners

Upcoming

Our next set up Next Gen API enhancements will include the following updates:

  • A new Assets path to return default Deal Settings for a given property

API Updates

Overview

The Tenant Contacts endpoint has new fields added for Lease IDs

New API Features

In Tenant Contacts, added a new relationship which links to Lease IDs filtered by Contact IDs:

  • Relationship: Link to Lease endpoint with contact_id filter

Upcoming

Our next set up Next Gen API enhancements will include the following updates:

  • Exposing Relationship Owners through the Tenant endpoints
  • A new Assets path to return default Deal Settings for a given property

API Updates

Overview

We’re adding new metadata fields to the Asset endpoint that allows clients to retrieve more metadata about a given asset. This enhancement aligns the inputs of the New Property Form metadata with can be returned through the Asset endpoint.

New API Features

In the Assets, added metadata fields which include:

  • Owner
  • Owning company
  • Asset Managers
  • Fund
  • Legal Entity
  • JV Partners
  • Clients
These fields can now be retrieved from the Assets endpoint

These fields can now be retrieved from the Assets endpoint

Upcoming

Our next set up Next Gen API enhancements will include the following updates:

  • Tenant Contacts to link to Lease IDs
  • A new Assets path to return default Deal Settings for a given property

Changelog for June 30, 2023

by VTS Integrations

API Updates

Overview

We shifted our efforts this month to monitoring and improving the data ingestion pipeline to be more flexible and efficient. However, we’re still keeping our pulse on the export APIs and how to expand their reach. For this month, the only visible change is new “Commission by Type” object that returns the commission sub-total for the tenant and the landlord.

New API Features

In Deal Terms added Landlord Commissions and Tenant Commissions so that commission sub-totals can be leveraged across both the UI and the APIs (in addition to the commission totals and period breakdowns)

These two sub-totals now available in the Deal Terms API as "Commission by Type"

These two sub-totals now available in the Deal Terms API

Upcoming

No new objects planned for the future sprints

Changelog for May 1, 2023

by VTS Integrations

API Updates

Overview

It’s official: This month marks the completion of the bringing out legacy Deal Export and Portfolio Export APIs into complete parity with Next Gen. All endpoints found within the Legacy APIs can be called from our Next Gen instances.

In addition, we’ve added a new field to our standard endpoints to help keep better track of spaces and deprecated a broker object that was adding more questions than clarity.

New API Features

In Asset added size to so the building’s total spaces can also be tracked at the building level. See screenshot below for where it can be found on in the Edit Building page:

VTS Edit Building Page with "Size" highlighted

The "size" field from the Edit Building page now returns in the Asset endpoint

Upcoming

We’re currently working on

  • the ability to exclude options from expired leases for customers using our MRI API integration
  • Investigating deal_terms performance and potential improvements that can be found

Interested in using our Next-Generation API Suite? Request Access by emailing [email protected]