LIST Tag
curl --request GET \
--url https://api.prophia.com/rest/v2/accounts/{accountId}/leases/{leaseId}/tags \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.prophia.com/rest/v2/accounts/{accountId}/leases/{leaseId}/tags"
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}/tags', 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}/tags",
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}/tags"
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}/tags")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prophia.com/rest/v2/accounts/{accountId}/leases/{leaseId}/tags")
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>",
"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>",
"applicableSpaces": [
{
"name": "<string>",
"buildingId": "<string>",
"scope": "BUILDING"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"tagSelections": [
{
"docPageId": "<string>",
"boundingBox": {
"x": 123,
"y": 123,
"width": 123,
"height": 123
},
"sequence": 123
}
],
"pages": [
{
"id": "<string>",
"pageSequence": 123,
"width": 123,
"height": 123
}
],
"url": "<string>"
}
],
"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."
}Leases
LIST Tag
Returns a paged list of the Tags (structured lease terms) extracted from the Lease’s Documents, resolved against the lease’s consolidated tag view. That view is rebuilt in the background about 10 minutes after the most recent tag change on the lease and returns the previous values until then; use LIST Raw Tag to see tags as they were just created or edited.
Required capabilities: READ:TAG
GET
/
rest
/
v2
/
accounts
/
{accountId}
/
leases
/
{leaseId}
/
tags
LIST Tag
curl --request GET \
--url https://api.prophia.com/rest/v2/accounts/{accountId}/leases/{leaseId}/tags \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.prophia.com/rest/v2/accounts/{accountId}/leases/{leaseId}/tags"
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}/tags', 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}/tags",
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}/tags"
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}/tags")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prophia.com/rest/v2/accounts/{accountId}/leases/{leaseId}/tags")
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>",
"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>",
"applicableSpaces": [
{
"name": "<string>",
"buildingId": "<string>",
"scope": "BUILDING"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"tagSelections": [
{
"docPageId": "<string>",
"boundingBox": {
"x": 123,
"y": 123,
"width": 123,
"height": 123
},
"sequence": 123
}
],
"pages": [
{
"id": "<string>",
"pageSequence": 123,
"width": 123,
"height": 123
}
],
"url": "<string>"
}
],
"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."
}Filters
Filters combine with AND: a result must match every filter you supply.| Filter | Description |
|---|---|
tagName | Case-insensitive contains match on the tag name. |
isCustomTag | Filters to custom tags (true) or standard-definition tags (false); omit for both. |
lifecycleStatus | Exact match on the tag’s lifecycle status. |
createdAtAfter | Tags created at or after this timestamp; inclusive. |
createdAtBefore | Tags created at or before this timestamp; inclusive. |
Authorizations
Query Parameters
Optional collections to populate. Unknown keys are rejected with 400.
tagSelections— adds the citation list (bounding boxes on doc pages).pages— adds the per-page geometry for cited pages.applicableSpaces— adds the suite/floor list this tag applies to.
Available options:
tagSelections, pages, applicableSpaces Response
OK

