GET Lease
curl --request GET \
--url https://api.prophia.com/rest/v2/accounts/{accountId}/leases/{leaseId} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.prophia.com/rest/v2/accounts/{accountId}/leases/{leaseId}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.prophia.com/rest/v2/accounts/{accountId}/leases/{leaseId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.prophia.com/rest/v2/accounts/{accountId}/leases/{leaseId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.prophia.com/rest/v2/accounts/{accountId}/leases/{leaseId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.prophia.com/rest/v2/accounts/{accountId}/leases/{leaseId}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prophia.com/rest/v2/accounts/{accountId}/leases/{leaseId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"accountId": "<string>",
"propertyId": "<string>",
"propertyCustomId": "<string>",
"propertyName": "<string>",
"buildingId": "<string>",
"buildingCustomId": "<string>",
"buildingName": "<string>",
"buildingType": "OFFICE",
"address": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"zipcode": "<string>"
},
"tenantLegalName": "<string>",
"dba": "<string>",
"customId": "<string>",
"url": "<string>",
"leaseStatus": "<string>",
"leaseType": "OFFICE",
"leasedFloors": "<string>",
"suiteNumber": [
{
"name": "<string>",
"buildingId": "<string>",
"scope": "BUILDING"
}
],
"squareFootage": 123,
"commenceDate": "2023-11-07T05:31:56Z",
"expirationDate": "2023-11-07T05:31:56Z",
"tags": [
{
"id": "<string>",
"tagName": "<string>",
"displayName": "<string>",
"isCustomTag": true,
"category": "STANDARD",
"value": {
"kind": "date",
"unit": "<string>",
"capturedData": "<string>",
"ocrText": "<string>",
"value": "<string>"
},
"customValue1": "<string>",
"customValue2": "<string>",
"customValue3": "<string>",
"customValue4": "<string>",
"customValue5": "<string>",
"customValue6": "<string>",
"schedule": {
"kind": "RENT",
"entries": [
{
"sequence": 123,
"startDate": "<string>",
"endDate": "<string>",
"startMonth": 123,
"endMonth": 123,
"squareFootage": 123,
"baseRent": {
"kind": "money",
"unit": "<string>",
"capturedData": "<string>",
"ocrText": "<string>",
"value": "<string>",
"currency": "<string>"
},
"fixedRETaxes": {
"kind": "money",
"unit": "<string>",
"capturedData": "<string>",
"ocrText": "<string>",
"value": "<string>",
"currency": "<string>"
},
"fixedOpex": {
"kind": "money",
"unit": "<string>",
"capturedData": "<string>",
"ocrText": "<string>",
"value": "<string>",
"currency": "<string>"
},
"fixedParking": {
"kind": "money",
"unit": "<string>",
"capturedData": "<string>",
"ocrText": "<string>",
"value": "<string>",
"currency": "<string>"
},
"annualTiRent": {
"kind": "money",
"unit": "<string>",
"capturedData": "<string>",
"ocrText": "<string>",
"value": "<string>",
"currency": "<string>"
},
"annualBsacRent": {
"kind": "money",
"unit": "<string>",
"capturedData": "<string>",
"ocrText": "<string>",
"value": "<string>",
"currency": "<string>"
},
"cpiIncreaseAmount": {
"kind": "money",
"unit": "<string>",
"capturedData": "<string>",
"ocrText": "<string>",
"value": "<string>",
"currency": "<string>"
}
}
]
},
"tagComponents": {
"kind": "AUTO_RENEWAL",
"rightStatus": "AVAILABLE",
"rightIsStricken": "<string>",
"customLabel": "<string>",
"effectiveDateOfRight": {
"kind": "number",
"unit": "<string>",
"capturedData": "<string>",
"ocrText": "<string>",
"value": 123
},
"clause": "<string>",
"amendingTag": {
"effectiveDate": "<string>",
"amendedTagId": "<string>"
},
"componentTags": {},
"advancedNoticePeriod": {
"kind": "number",
"unit": "<string>",
"capturedData": "<string>",
"ocrText": "<string>",
"value": 123
},
"autoRenewalTerm": {
"kind": "number",
"unit": "<string>",
"capturedData": "<string>",
"ocrText": "<string>",
"value": 123
},
"autoRenewalPeriods": {
"kind": "number",
"unit": "<string>",
"capturedData": "<string>",
"ocrText": "<string>",
"value": 123
},
"autoRenewalRate": {
"kind": "money",
"unit": "<string>",
"capturedData": "<string>",
"ocrText": "<string>",
"value": "<string>",
"currency": "<string>"
},
"autoRenewalRateBump": {
"kind": "percent",
"unit": "<string>",
"capturedData": "<string>",
"ocrText": "<string>",
"value": 123
},
"effectivePeriod": {
"kind": "dateRange",
"unit": "<string>",
"capturedData": "<string>",
"ocrText": "<string>",
"start": "<string>",
"end": "<string>"
}
},
"amendingTag": {
"effectiveDate": "<string>",
"amendedTagId": "<string>"
},
"lifecycleStatus": "ACTIVE",
"leaseId": "<string>",
"leaseDocId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"url": "<string>"
}
],
"documents": {},
"leaseScore": {
"score": 123,
"missingMLA": true
},
"parent": {
"id": "<string>",
"url": "<string>",
"leaseStatus": "<string>",
"leaseSubStatus": {
"status": "MONTH_TO_MONTH",
"startDate": "2023-11-07T05:31:56Z"
}
},
"leaseSubStatus": {
"status": "MONTH_TO_MONTH",
"startDate": "2023-11-07T05:31:56Z"
},
"docCompletionStatus": "<string>",
"rentType": "Gross",
"opexTaxTypes": [
{
"space": {
"name": "<string>",
"buildingId": "<string>",
"scope": "BUILDING"
},
"opexTaxType": "Gross"
}
],
"floatingCommencement": true,
"autoRenewalExpirationDates": [
{
"space": {
"name": "<string>",
"buildingId": "<string>",
"scope": "BUILDING"
},
"dates": [
"2023-11-07T05:31:56Z"
]
}
],
"subleases": [
{
"id": "<string>",
"url": "<string>",
"leaseStatus": "<string>",
"leaseSubStatus": {
"status": "MONTH_TO_MONTH",
"startDate": "2023-11-07T05:31:56Z"
}
}
]
}{
"error": "Invalid Input",
"errorCode": "InvalidInput",
"message": "Unknown include keys: [bogus]; supported: [tags, documents, subleases]",
"status": "400 BAD_REQUEST",
"timestamp": "2026-09-02T20:41:03.118Z",
"localizedMessage": "Unknown include keys: [bogus]; supported: [tags, documents, subleases]"
}{
"error": "JWT authentication is not supported. Use an API key."
}{
"error": "Access Denied",
"errorCode": "AccessDenied",
"message": "Not authorized. Missing capabilities: READ:TAG",
"status": "403 FORBIDDEN",
"timestamp": "2026-09-02T20:41:03.118Z",
"localizedMessage": "Not authorized. Missing capabilities: READ:TAG"
}{
"error": "Entity Not Found",
"errorCode": "EntityNotFound",
"message": "This entity is not found in the system.",
"status": "404 NOT_FOUND",
"timestamp": "2026-09-02T20:41:03.118Z",
"localizedMessage": "This entity is not found in the system."
}Leases
GET Lease
Returns a single Lease by id.
Required capabilities: READ:LEASE
GET
/
rest
/
v2
/
accounts
/
{accountId}
/
leases
/
{leaseId}
GET Lease
curl --request GET \
--url https://api.prophia.com/rest/v2/accounts/{accountId}/leases/{leaseId} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.prophia.com/rest/v2/accounts/{accountId}/leases/{leaseId}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.prophia.com/rest/v2/accounts/{accountId}/leases/{leaseId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.prophia.com/rest/v2/accounts/{accountId}/leases/{leaseId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.prophia.com/rest/v2/accounts/{accountId}/leases/{leaseId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.prophia.com/rest/v2/accounts/{accountId}/leases/{leaseId}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prophia.com/rest/v2/accounts/{accountId}/leases/{leaseId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"accountId": "<string>",
"propertyId": "<string>",
"propertyCustomId": "<string>",
"propertyName": "<string>",
"buildingId": "<string>",
"buildingCustomId": "<string>",
"buildingName": "<string>",
"buildingType": "OFFICE",
"address": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"zipcode": "<string>"
},
"tenantLegalName": "<string>",
"dba": "<string>",
"customId": "<string>",
"url": "<string>",
"leaseStatus": "<string>",
"leaseType": "OFFICE",
"leasedFloors": "<string>",
"suiteNumber": [
{
"name": "<string>",
"buildingId": "<string>",
"scope": "BUILDING"
}
],
"squareFootage": 123,
"commenceDate": "2023-11-07T05:31:56Z",
"expirationDate": "2023-11-07T05:31:56Z",
"tags": [
{
"id": "<string>",
"tagName": "<string>",
"displayName": "<string>",
"isCustomTag": true,
"category": "STANDARD",
"value": {
"kind": "date",
"unit": "<string>",
"capturedData": "<string>",
"ocrText": "<string>",
"value": "<string>"
},
"customValue1": "<string>",
"customValue2": "<string>",
"customValue3": "<string>",
"customValue4": "<string>",
"customValue5": "<string>",
"customValue6": "<string>",
"schedule": {
"kind": "RENT",
"entries": [
{
"sequence": 123,
"startDate": "<string>",
"endDate": "<string>",
"startMonth": 123,
"endMonth": 123,
"squareFootage": 123,
"baseRent": {
"kind": "money",
"unit": "<string>",
"capturedData": "<string>",
"ocrText": "<string>",
"value": "<string>",
"currency": "<string>"
},
"fixedRETaxes": {
"kind": "money",
"unit": "<string>",
"capturedData": "<string>",
"ocrText": "<string>",
"value": "<string>",
"currency": "<string>"
},
"fixedOpex": {
"kind": "money",
"unit": "<string>",
"capturedData": "<string>",
"ocrText": "<string>",
"value": "<string>",
"currency": "<string>"
},
"fixedParking": {
"kind": "money",
"unit": "<string>",
"capturedData": "<string>",
"ocrText": "<string>",
"value": "<string>",
"currency": "<string>"
},
"annualTiRent": {
"kind": "money",
"unit": "<string>",
"capturedData": "<string>",
"ocrText": "<string>",
"value": "<string>",
"currency": "<string>"
},
"annualBsacRent": {
"kind": "money",
"unit": "<string>",
"capturedData": "<string>",
"ocrText": "<string>",
"value": "<string>",
"currency": "<string>"
},
"cpiIncreaseAmount": {
"kind": "money",
"unit": "<string>",
"capturedData": "<string>",
"ocrText": "<string>",
"value": "<string>",
"currency": "<string>"
}
}
]
},
"tagComponents": {
"kind": "AUTO_RENEWAL",
"rightStatus": "AVAILABLE",
"rightIsStricken": "<string>",
"customLabel": "<string>",
"effectiveDateOfRight": {
"kind": "number",
"unit": "<string>",
"capturedData": "<string>",
"ocrText": "<string>",
"value": 123
},
"clause": "<string>",
"amendingTag": {
"effectiveDate": "<string>",
"amendedTagId": "<string>"
},
"componentTags": {},
"advancedNoticePeriod": {
"kind": "number",
"unit": "<string>",
"capturedData": "<string>",
"ocrText": "<string>",
"value": 123
},
"autoRenewalTerm": {
"kind": "number",
"unit": "<string>",
"capturedData": "<string>",
"ocrText": "<string>",
"value": 123
},
"autoRenewalPeriods": {
"kind": "number",
"unit": "<string>",
"capturedData": "<string>",
"ocrText": "<string>",
"value": 123
},
"autoRenewalRate": {
"kind": "money",
"unit": "<string>",
"capturedData": "<string>",
"ocrText": "<string>",
"value": "<string>",
"currency": "<string>"
},
"autoRenewalRateBump": {
"kind": "percent",
"unit": "<string>",
"capturedData": "<string>",
"ocrText": "<string>",
"value": 123
},
"effectivePeriod": {
"kind": "dateRange",
"unit": "<string>",
"capturedData": "<string>",
"ocrText": "<string>",
"start": "<string>",
"end": "<string>"
}
},
"amendingTag": {
"effectiveDate": "<string>",
"amendedTagId": "<string>"
},
"lifecycleStatus": "ACTIVE",
"leaseId": "<string>",
"leaseDocId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"url": "<string>"
}
],
"documents": {},
"leaseScore": {
"score": 123,
"missingMLA": true
},
"parent": {
"id": "<string>",
"url": "<string>",
"leaseStatus": "<string>",
"leaseSubStatus": {
"status": "MONTH_TO_MONTH",
"startDate": "2023-11-07T05:31:56Z"
}
},
"leaseSubStatus": {
"status": "MONTH_TO_MONTH",
"startDate": "2023-11-07T05:31:56Z"
},
"docCompletionStatus": "<string>",
"rentType": "Gross",
"opexTaxTypes": [
{
"space": {
"name": "<string>",
"buildingId": "<string>",
"scope": "BUILDING"
},
"opexTaxType": "Gross"
}
],
"floatingCommencement": true,
"autoRenewalExpirationDates": [
{
"space": {
"name": "<string>",
"buildingId": "<string>",
"scope": "BUILDING"
},
"dates": [
"2023-11-07T05:31:56Z"
]
}
],
"subleases": [
{
"id": "<string>",
"url": "<string>",
"leaseStatus": "<string>",
"leaseSubStatus": {
"status": "MONTH_TO_MONTH",
"startDate": "2023-11-07T05:31:56Z"
}
}
]
}{
"error": "Invalid Input",
"errorCode": "InvalidInput",
"message": "Unknown include keys: [bogus]; supported: [tags, documents, subleases]",
"status": "400 BAD_REQUEST",
"timestamp": "2026-09-02T20:41:03.118Z",
"localizedMessage": "Unknown include keys: [bogus]; supported: [tags, documents, subleases]"
}{
"error": "JWT authentication is not supported. Use an API key."
}{
"error": "Access Denied",
"errorCode": "AccessDenied",
"message": "Not authorized. Missing capabilities: READ:TAG",
"status": "403 FORBIDDEN",
"timestamp": "2026-09-02T20:41:03.118Z",
"localizedMessage": "Not authorized. Missing capabilities: READ:TAG"
}{
"error": "Entity Not Found",
"errorCode": "EntityNotFound",
"message": "This entity is not found in the system.",
"status": "404 NOT_FOUND",
"timestamp": "2026-09-02T20:41:03.118Z",
"localizedMessage": "This entity is not found in the system."
}Authorizations
Query Parameters
Optional collections to populate. Note: combining tags and documents on a heavily-tagged lease can produce a very large response — prefer requesting one at a time. Unknown keys are rejected with 400.
tags— adds the consolidated DocTag list extracted from this lease's documents (rent, options, dates, etc.).- Requires the
READ:TAGcapability.
- Requires the
documents— adds per-document page geometry keyed by leaseDocId, for resolvingtagSelections[].docPageIdreferences.- Requires the
READ:DOCUMENTcapability.
- Requires the
subleases— adds the list of subleases of this lease as lightweight refs (id, url, current leaseStatus and leaseSubStatus); empty when the lease has no subleases.
Available options:
tags, documents, subleases Response
OK
Representation of a single Lease. A Lease is directly associated with one Building, denoted by its buildingId reference. A Lease's current active residence can be in one or more Buildings, which may or may not be its original Building reference - inspect the suiteNumber field to understand which BuildingSpaces in which Buildings the Lease is currently active in.
Headline lease state as shown in the app. On this endpoint it is one of Active, Expired, or Not Started — note the spacing and casing — but it is typed as a free-form string rather than an enum, because the same field name carries a wider set on the v0 API, so do not switch on it exhaustively. It is derived, not stored: Prophia recomputes it from the lease's commence and expiration dates against today, so it changes on its own as those dates pass. Pair with leaseSubStatus to tell an expired lease from one running month-to-month or one that has been vacated post-expiration.
Classification of the agreement. Some lease types have specialized Tag sets available to them: GSA_OFFICE and RETAIL leases each have unique Tags available for capture that other lease types do not. Changing a lease's type removes those specialized Tags from the UI, APIs, and Reports, but does not delete them — reverting to the matching type brings them back.
Available options:
OFFICE, GSA_OFFICE, RETAIL, INDUSTRIAL, STORAGE, LICENSE_AGREEMENT, TELECOM_ANTENNA, PARKING_AGREEMENT, ROOFTOP_SOLAR Floors the lease occupies, as a comma-separated string. Derived rather than captured: each suite in suiteNumber is matched to a building space and contributes that space's floor, plus any floor named directly on a floor-scoped space. A suite that matches no building space contributes nothing, and a floor in another building is suffixed with @buildingId the way cross-building suites are. The order is not stable, and the value is rebuilt when Prophia consolidates the lease's tags — editing a space's floor afterwards leaves this stale until the next consolidation.
The lease's extracted terms; only populated when include=tags is present in the request parameters. Filtered based the lease's current leaseType. Each tag appears once. A tag's applicableSpaces lists the suites it applies to in the lease's consolidated per-space view (a space-dependent term captured without suites applies to every space) and is omitted for space-independent terms. Lease-level values (commencement, expiration, square footage, suites) are on the lease's top-level fields.
Show child attributes
Show child attributes