VTS Account Admin API
The Account Admin API from VTS — 11 operation(s) for account admin.
OpenAPI Specification
openapi: 3.0.2
info:
title: VTS Lease Account Admin API
version: v1
description: VTS Lease REST API — the commercial real estate leasing, asset management, and portfolio data surface of the VTS platform. Resources include assets, spaces, leases, deals, deal terms, lease terms, financials, budgets, tenants, buildings, listings, and the Leasing Availability API. Harvested verbatim from the VTS developer portal (readme.vts.com) per-operation OpenAPI fragments.
contact:
name: VTS API Support
url: https://readme.vts.com/
termsOfService: https://www.vts.com/services-terms
servers:
- url: https://api.vts.com
- url: https://sandbox.vts.com
description: Sandbox
security:
- basic_auth: []
tags:
- name: Account Admin
paths:
/api/v1/account_admin/approval_settings:
get:
summary: Fetches approval settings
tags:
- Account Admin
security:
- basic_auth: []
parameters:
- name: page[size]
in: query
required: false
description: 'The number of items returned for any one page (default: 10, max: 100)'
schema:
type: integer
- name: page[before]
in: query
required: false
description: Show records before the given page indicator
schema:
type: string
- name: page[after]
in: query
required: false
description: Show records after the given page indicator
schema:
type: string
- name: filter[updated_since]
in: query
schema:
type: string
format: date-time
required: false
description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.)
example: '2021-03-15'
responses:
'200':
description: Returns list of Approval settings
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
type:
type: string
id:
type: string
attributes:
type: object
properties:
name:
type: string
example: New Approval Setting
deal_types:
type: array
items:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: New Deal
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
space_types:
type: array
items:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: Education
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
relationships:
description: The objects linked to a approval settings
type: object
properties:
asset_group:
type: object
properties:
links:
type: object
properties:
related:
type: string
example: https://api.vts.com/api/v1/account_admin/asset_groups?id=1
data:
type: object
properties:
type:
type: string
example: asset_groups
id:
type: string
example: '1'
watcher:
type: object
properties:
data:
type: array
items:
type: object
properties:
type:
type: string
example: users
id:
type: string
example: '1'
approver_slots:
type: object
properties:
data:
type: array
items:
type: object
properties:
type:
type: string
example: approver_slots
id:
type: string
example: '1'
links:
type: object
properties:
related:
type: string
example: https://api.vts.com/api/v1/account_admin/approver_slots?filter%5Bapproval_setting_id%5D=1
links:
type: object
properties:
self:
type: string
example: https://api.vts.com/api/v1/account_admin/approval_settings?page%5Bafter%5D=MzE2NTE%253D
description: The current URL
prev:
type: string
example: https://api.vts.com/api/v1/account_admin/approval_settings?page%5Bbefore%5D=MzE2NTI%253D
description: URL for the previous page of Approval Setting
next:
type: string
example: https://api.vts.com/api/v1/account_admin/approval_settings?page%5Bbefore%5D=MzE2NTI%253D
description: URL for the next page of Approval Setting
required:
- self
'403':
description: API not authorized for use
content:
application/json:
schema:
$ref: '#/components/schemas/errors_object'
operationId: get_api-v1-account-admin-approval-settings
/api/v1/account_admin/approver_rules:
get:
summary: Fetches approver rules
tags:
- Account Admin
security:
- basic_auth: []
parameters:
- name: page[size]
in: query
required: false
description: 'The number of items returned for any one page (default: 10, max: 100)'
schema:
type: integer
- name: page[before]
in: query
required: false
description: Show records before the given page indicator
schema:
type: string
- name: page[after]
in: query
required: false
description: Show records after the given page indicator
schema:
type: string
- name: filter[updated_since]
in: query
schema:
type: string
format: date-time
required: false
description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.)
example: '2021-03-15'
responses:
'200':
description: Returns list of Approver Rules
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
type:
type: string
id:
type: string
attributes:
type: object
properties:
order_number:
type: number
example: 1
rule_type:
type: string
enum:
- above_budget
- below_budget
- capital_variance_above_budget
- cost
- deal_term_greater_than
- deal_term_less_than
- lease_infos
- ner_to_break_below_budget
- options_and_rights
- rentable_size
- size_greater_than
- size_less_than
- total_capital
- total_capital_less_than
- year_one_total_rent
example: above_budget
description: Represents the type of the approver rule as stored in the database.
rule_name:
type: string
example: NER Variance Above Budget
description: Represents a user-friendly label or name for the approver rule type.
condition:
type: string
enum:
- and
- or
example: and
threshold:
type: object
properties:
value:
type: number
example: 1
unit:
type: string
example: '%'
nullable: true
right_types:
type: array
items:
type: string
example: audit rights
enum:
- audit rights
- cap on rates
- co-tenancy
- contraction
- exclusive use
- generator rights
- go dark
- kick out
- landlord & tenant act 1954
- make good
- must lease
- other
- parking
- purchase
- radius
- relocation
- rent review
- rofn
- set off rights
- signage
- special provisions
- storage
- sublease
- use
- break
- expansion
- renewal
- rights to terminate
- rofo
- rofr
description: The type of the right
nullable: true
lease_info_types:
type: array
items:
type: string
example: guarantor
enum:
- guarantor
- tenant notice info
- lease drafter
- certificate of insurance
- development impact
- other
description: The type of the lease info
nullable: true
relationships:
description: The objects linked to a approver rules
type: object
properties:
approver_slot:
type: object
properties:
links:
type: object
properties:
related:
type: string
example: https://api.vts.com/api/v1/account_admin/approver_slots/1
data:
type: object
properties:
type:
type: string
example: approver_slots
id:
type: string
example: '1'
links:
type: object
properties:
self:
type: string
example: https://api.vts.com/api/v1/account_admin/approver_rules?page%5Bafter%5D=MzE2NTE%253D
description: The current URL
prev:
type: string
example: https://api.vts.com/api/v1/account_admin/approver_rules?page%5Bbefore%5D=MzE2NTI%253D
description: URL for the previous page of Approver Rules
next:
type: string
example: https://api.vts.com/api/v1/account_admin/approver_rules?page%5Bbefore%5D=MzE2NTI%253D
description: URL for the next page of Approver Rules
required:
- self
'403':
description: API not authorized for use
content:
application/json:
schema:
$ref: '#/components/schemas/errors_object'
operationId: get_api-v1-account-admin-approver-rules
/api/v1/account_admin/approver_slots:
get:
summary: Fetches approver slots
tags:
- Account Admin
security:
- basic_auth: []
parameters:
- name: page[size]
in: query
required: false
description: 'The number of items returned for any one page (default: 10, max: 100)'
schema:
type: integer
- name: page[before]
in: query
required: false
description: Show records before the given page indicator
schema:
type: string
- name: page[after]
in: query
required: false
description: Show records after the given page indicator
schema:
type: string
- name: filter[updated_since]
in: query
schema:
type: string
format: date-time
required: false
description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.)
example: '2021-03-15'
responses:
'200':
description: Returns list of Approver Slots
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
type:
type: string
id:
type: string
attributes:
type: object
properties:
description:
type: string
example: Approver Slots Description
order_number:
type: number
example: 1
relationships:
description: The objects linked to a approver slots
type: object
properties:
approver:
type: object
properties:
links:
type: object
properties:
related:
type: string
example: https://api.vts.com/api/v1/users/1
data:
type: object
properties:
type:
type: string
example: users
id:
type: string
example: '1'
approver_rules:
type: object
properties:
data:
type: array
items:
type: object
properties:
type:
type: string
example: approver_rules
id:
type: string
example: '1'
links:
type: object
properties:
related:
type: string
example: https://api.vts.com/api/v1/account_admin/approver_rules?filter%5Bapprover_slot_id%5D=1
links:
type: object
properties:
self:
type: string
example: https://api.vts.com/api/v1/account_admin/approver_slots?page%5Bafter%5D=MzE2NTE%253D
description: The current URL
prev:
type: string
example: https://api.vts.com/api/v1/account_admin/approver_slots?page%5Bbefore%5D=MzE2NTI%253D
description: URL for the previous page of Approver Slots
next:
type: string
example: https://api.vts.com/api/v1/account_admin/approver_slots?page%5Bbefore%5D=MzE2NTI%253D
description: URL for the next page of Approver Slots
required:
- self
'403':
description: API not authorized for use
content:
application/json:
schema:
$ref: '#/components/schemas/errors_object'
operationId: get_api-v1-account-admin-approver-slots
/api/v1/account_admin/approver_slots/{id}:
get:
summary: Retrieves specific approver slots
tags:
- Account Admin
security:
- basic_auth: []
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: Returns requested approver slot if it exists
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
type:
type: string
id:
type: string
attributes:
type: object
properties:
description:
type: string
example: Approver Slots Description
order_number:
type: number
example: 1
relationships:
description: The objects linked to a approver slots
type: object
properties:
approver:
type: object
properties:
links:
type: object
properties:
related:
type: string
example: https://api.vts.com/api/v1/users/1
data:
type: object
properties:
type:
type: string
example: users
id:
type: string
example: '1'
approver_rules:
type: object
properties:
data:
type: array
items:
type: object
properties:
type:
type: string
example: approver_rules
id:
type: string
example: '1'
links:
type: object
properties:
related:
type: string
example: https://api.vts.com/api/v1/account_admin/approver_rules?filter%5Bapprover_slot_id%5D=1
'403':
description: API not authorized for use
content:
application/json:
schema:
$ref: '#/components/schemas/errors_object'
'404':
description: Requested approver slot does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/errors_object'
operationId: get_api-v1-account-admin-approver-slots-id
/api/v1/account_admin/asset_groups:
get:
summary: Fetches asset groups
tags:
- Account Admin
security:
- basic_auth: []
parameters:
- name: page[size]
in: query
required: false
description: 'The number of items returned for any one page (default: 10, max: 100)'
schema:
type: integer
- name: page[before]
in: query
required: false
description: Show records before the given page indicator
schema:
type: string
- name: page[after]
in: query
required: false
description: Show records after the given page indicator
schema:
type: string
- name: filter[updated_since]
in: query
schema:
type: string
format: date-time
required: false
description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.)
example: '2021-03-15'
responses:
'200':
description: Returns list of Asset Groups
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
type:
type: string
id:
type: string
attributes:
type: object
properties:
name:
type: string
example: New Deal
relationships:
description: The objects linked to a Asset Group
type: object
properties:
assets:
type: object
properties:
links:
type: object
properties:
related:
type: string
example: https://api.vts.com/api/v1/assets?filter%5Basset_group_id%5D=1
data:
type: array
items:
type: object
properties:
id:
type: string
example: 100
type:
type: string
example: assets
task_settings:
type: object
properties:
links:
type: object
properties:
related:
type: string
example: https://api.vts.com/api/v1/account_admin/task_settings?filter%5Basset_group_id%5D=1
data:
type: array
items:
type: object
properties:
id:
type: string
example: 100
type:
type: string
example: task_settings
links:
type: object
properties:
self:
type: string
example: https://api.vts.com/api/v1/account_admin/asset_groups?page%5Bafter%5D=MzE2NTE%253D
description: The current URL
prev:
type: string
example: https://api.vts.com/api/v1/account_admin/asset_groups?page%5Bbefore%5D=MzE2NTI%253D
description: URL for the previous page of Asset Group
next:
type: string
example: https://api.vts.com/api/v1/account_admin/asset_groups?page%5Bbefore%5D=MzE2NTI%253D
description: URL for the next page of Asset Group
required:
- self
'403':
description: API not authorized for use
content:
application/json:
schema:
$ref: '#/components/schemas/errors_object'
operationId: get_api-v1-account-admin-asset-groups
/api/v1/account_admin/asset_groups/{id}:
get:
summary: Retrieves specific asset groups
tags:
- Account Admin
security:
- basic_auth: []
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: Returns requested asset group if it exists
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
type:
type: string
id:
type: string
attributes:
type: object
properties:
name:
type: string
example: New Deal
relationships:
description: The objects linked to a Asset Group
type: object
properties:
assets:
type: object
properties:
links:
type: object
properties:
related:
type: string
example: https://api.vts.com/api/v1/assets?filter%5Basset_group_id%5D=1
data:
type: array
items:
type: object
properties:
id:
type: string
example: 100
type:
type: string
example: assets
task_settings:
type: object
properties:
links:
type: object
p
# --- truncated at 32 KB (58 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vts/refs/heads/main/openapi/vts-account-admin-api-openapi.yml