LIST Leases Recently Updated
curl --request GET \
--url https://api.prophia.com/rest/v2/accounts/{accountId}/recent_changed_leases \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.prophia.com/rest/v2/accounts/{accountId}/recent_changed_leases"
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}/recent_changed_leases', 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}/recent_changed_leases",
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}/recent_changed_leases"
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}/recent_changed_leases")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prophia.com/rest/v2/accounts/{accountId}/recent_changed_leases")
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{
"totalCount": 123,
"page": 123,
"limit": 123,
"items": [
{
"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"
}
}
]
}
],
"hasMore": true
}{
"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."
}Accounts
LIST Leases Recently Updated
Returns a paged list of leases whose documents have had data updated between start_date and end_date (both inclusive), limited to buildings your api key is permitted to access. This is the change-detection primitive for sync jobs: poll it and re-fetch only the leases it names instead of re-crawling the account.
Required capabilities: READ:LEASE
GET
/
rest
/
v2
/
accounts
/
{accountId}
/
recent_changed_leases
LIST Leases Recently Updated
curl --request GET \
--url https://api.prophia.com/rest/v2/accounts/{accountId}/recent_changed_leases \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.prophia.com/rest/v2/accounts/{accountId}/recent_changed_leases"
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}/recent_changed_leases', 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}/recent_changed_leases",
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}/recent_changed_leases"
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}/recent_changed_leases")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prophia.com/rest/v2/accounts/{accountId}/recent_changed_leases")
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{
"totalCount": 123,
"page": 123,
"limit": 123,
"items": [
{
"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"
}
}
]
}
],
"hasMore": true
}{
"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