LIST Building
curl --request GET \
--url https://api.prophia.com/rest/v2/accounts/{accountId}/buildings \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.prophia.com/rest/v2/accounts/{accountId}/buildings"
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}/buildings', 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}/buildings",
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}/buildings"
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}/buildings")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prophia.com/rest/v2/accounts/{accountId}/buildings")
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>",
"propertyId": "<string>",
"buildingName": "<string>",
"address": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"zipcode": "<string>"
},
"onboardingStatus": "NOT_STARTED",
"activeStatus": "ACTIVE",
"customId": "<string>",
"implementationManager": "<string>",
"buildingType": "OFFICE",
"buildingClass": "<string>",
"metroArea": "<string>",
"lat": 123,
"lng": 123,
"propertyType": "MULTI_BUILDING",
"totalRentableSquareFootage": 123,
"squareFootageLeased": 123,
"squareFootageOccupied": 123,
"squareFootageVacant": 123,
"leases": [
{
"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",
"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"
]
}
]
}
],
"documents": [
{
"id": "<string>",
"filename": "<string>",
"title": "<string>",
"numberOfPages": 123,
"docCategory": "Main Lease Agreement",
"createdAt": "2023-11-07T05:31:56Z",
"documentStatus": "<string>",
"splitStatus": "single",
"originalDocId": "<string>"
}
],
"spaces": [
{
"id": "<string>",
"buildingId": "<string>",
"floor": "<string>",
"suiteNumber": "<string>",
"squareFootage": 123,
"type": "Office",
"rentable": true,
"archived": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"occupied": true
}
],
"customFields": [
{
"name": "<string>",
"value": "<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."
}Buildings
LIST Building
Returns a paged list of the Account’s Buildings
Required capabilities: READ:BUILDING
GET
/
rest
/
v2
/
accounts
/
{accountId}
/
buildings
LIST Building
curl --request GET \
--url https://api.prophia.com/rest/v2/accounts/{accountId}/buildings \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.prophia.com/rest/v2/accounts/{accountId}/buildings"
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}/buildings', 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}/buildings",
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}/buildings"
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}/buildings")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prophia.com/rest/v2/accounts/{accountId}/buildings")
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>",
"propertyId": "<string>",
"buildingName": "<string>",
"address": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"zipcode": "<string>"
},
"onboardingStatus": "NOT_STARTED",
"activeStatus": "ACTIVE",
"customId": "<string>",
"implementationManager": "<string>",
"buildingType": "OFFICE",
"buildingClass": "<string>",
"metroArea": "<string>",
"lat": 123,
"lng": 123,
"propertyType": "MULTI_BUILDING",
"totalRentableSquareFootage": 123,
"squareFootageLeased": 123,
"squareFootageOccupied": 123,
"squareFootageVacant": 123,
"leases": [
{
"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",
"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"
]
}
]
}
],
"documents": [
{
"id": "<string>",
"filename": "<string>",
"title": "<string>",
"numberOfPages": 123,
"docCategory": "Main Lease Agreement",
"createdAt": "2023-11-07T05:31:56Z",
"documentStatus": "<string>",
"splitStatus": "single",
"originalDocId": "<string>"
}
],
"spaces": [
{
"id": "<string>",
"buildingId": "<string>",
"floor": "<string>",
"suiteNumber": "<string>",
"squareFootage": 123,
"type": "Office",
"rentable": true,
"archived": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"occupied": true
}
],
"customFields": [
{
"name": "<string>",
"value": "<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 | Requires |
|---|---|---|
name | Case-insensitive contains match on the building name. | |
city | Case-insensitive exact match on the address city. | |
state | Case-insensitive exact match on the address state. | |
activeStatus | Filter by the building’s active status. | |
customId | Exact match on the building’s custom id. | |
buildingType | Filter by building type. | |
implementationManager | Case-insensitive contains match on the implementation manager’s name. | |
customFields | Custom Field filters, one entry per repeated parameter. | READ:CUSTOM_FIELD |
Authorizations
Query Parameters
Optional collections to populate. Unknown keys are rejected with 400.
leases— adds the list of leases under this building.- Requires the
READ:LEASEcapability.
- Requires the
documents— adds the list of building-level documents (e.g. rent rolls, stacking plans) attached at the building scope.- Requires the
READ:DOCUMENTcapability.
- Requires the
spaces— adds the list of suites/spaces (archived and non-archived) attached to this building.- Requires the
READ:BUILDING_SPACEcapability.
- Requires the
customFields— adds the building's values for its active Building Custom Fields, sorted by field name.- Requires the
READ:CUSTOM_FIELDcapability.
- Requires the
Available options:
leases, documents, spaces, customFields Custom Field filters, one entry per repeated parameter. Each entry is name=value to match a Building whose value for that field equals value, or just name to match a Building that has any value for that field. Names and values are exact, case-insensitive matches, and only active fields count. The entry is split on its first =, so values may contain = and commas. A Building must match every entry.
Requires the READ:CUSTOM_FIELD capability.
Response
OK

