CREATE Building

curl --request POST \
  --url https://api.prophia.com/rest/v2/accounts/{accountId}/buildings \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "propertyId": "<string>",
  "buildingName": "<string>",
  "address": {
    "address1": "<string>",
    "city": "<string>",
    "country": "<string>",
    "address2": "<string>",
    "state": "<string>",
    "zipcode": "<string>"
  },
  "customId": "<string>",
  "buildingClass": "<string>",
  "metroArea": "<string>"
}
'

import requests

url = "https://api.prophia.com/rest/v2/accounts/{accountId}/buildings"

payload = {
    "propertyId": "<string>",
    "buildingName": "<string>",
    "address": {
        "address1": "<string>",
        "city": "<string>",
        "country": "<string>",
        "address2": "<string>",
        "state": "<string>",
        "zipcode": "<string>"
    },
    "customId": "<string>",
    "buildingClass": "<string>",
    "metroArea": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    propertyId: '<string>',
    buildingName: '<string>',
    address: {
      address1: '<string>',
      city: '<string>',
      country: '<string>',
      address2: '<string>',
      state: '<string>',
      zipcode: '<string>'
    },
    customId: '<string>',
    buildingClass: '<string>',
    metroArea: '<string>'
  })
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'propertyId' => '<string>',
    'buildingName' => '<string>',
    'address' => [
        'address1' => '<string>',
        'city' => '<string>',
        'country' => '<string>',
        'address2' => '<string>',
        'state' => '<string>',
        'zipcode' => '<string>'
    ],
    'customId' => '<string>',
    'buildingClass' => '<string>',
    'metroArea' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prophia.com/rest/v2/accounts/{accountId}/buildings"

	payload := strings.NewReader("{\n  \"propertyId\": \"<string>\",\n  \"buildingName\": \"<string>\",\n  \"address\": {\n    \"address1\": \"<string>\",\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"address2\": \"<string>\",\n    \"state\": \"<string>\",\n    \"zipcode\": \"<string>\"\n  },\n  \"customId\": \"<string>\",\n  \"buildingClass\": \"<string>\",\n  \"metroArea\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.prophia.com/rest/v2/accounts/{accountId}/buildings")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"propertyId\": \"<string>\",\n  \"buildingName\": \"<string>\",\n  \"address\": {\n    \"address1\": \"<string>\",\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"address2\": \"<string>\",\n    \"state\": \"<string>\",\n    \"zipcode\": \"<string>\"\n  },\n  \"customId\": \"<string>\",\n  \"buildingClass\": \"<string>\",\n  \"metroArea\": \"<string>\"\n}")
  .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::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"propertyId\": \"<string>\",\n  \"buildingName\": \"<string>\",\n  \"address\": {\n    \"address1\": \"<string>\",\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"address2\": \"<string>\",\n    \"state\": \"<string>\",\n    \"zipcode\": \"<string>\"\n  },\n  \"customId\": \"<string>\",\n  \"buildingClass\": \"<string>\",\n  \"metroArea\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "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>"
    }
  ]
}

{
  "error": "Invalid Input",
  "errorCode": "InvalidInput",
  "message": "dba cannot be blank",
  "status": "400 BAD_REQUEST",
  "timestamp": "2026-09-02T20:41:03.118Z",
  "localizedMessage": "dba cannot be blank"
}

{
  "error": "JWT authentication is not supported. Use an API key."
}

{
  "error": "Access Denied",
  "errorCode": "AccessDenied",
  "message": "Not authorized. Missing capabilities: WRITE:DOCUMENT",
  "status": "403 FORBIDDEN",
  "timestamp": "2026-09-02T20:41:03.118Z",
  "localizedMessage": "Not authorized. Missing capabilities: WRITE:DOCUMENT"
}

{
  "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."
}

POST

rest

accounts

{accountId}

buildings

CREATE Building

curl --request POST \
  --url https://api.prophia.com/rest/v2/accounts/{accountId}/buildings \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "propertyId": "<string>",
  "buildingName": "<string>",
  "address": {
    "address1": "<string>",
    "city": "<string>",
    "country": "<string>",
    "address2": "<string>",
    "state": "<string>",
    "zipcode": "<string>"
  },
  "customId": "<string>",
  "buildingClass": "<string>",
  "metroArea": "<string>"
}
'

import requests

url = "https://api.prophia.com/rest/v2/accounts/{accountId}/buildings"

payload = {
    "propertyId": "<string>",
    "buildingName": "<string>",
    "address": {
        "address1": "<string>",
        "city": "<string>",
        "country": "<string>",
        "address2": "<string>",
        "state": "<string>",
        "zipcode": "<string>"
    },
    "customId": "<string>",
    "buildingClass": "<string>",
    "metroArea": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    propertyId: '<string>',
    buildingName: '<string>',
    address: {
      address1: '<string>',
      city: '<string>',
      country: '<string>',
      address2: '<string>',
      state: '<string>',
      zipcode: '<string>'
    },
    customId: '<string>',
    buildingClass: '<string>',
    metroArea: '<string>'
  })
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'propertyId' => '<string>',
    'buildingName' => '<string>',
    'address' => [
        'address1' => '<string>',
        'city' => '<string>',
        'country' => '<string>',
        'address2' => '<string>',
        'state' => '<string>',
        'zipcode' => '<string>'
    ],
    'customId' => '<string>',
    'buildingClass' => '<string>',
    'metroArea' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prophia.com/rest/v2/accounts/{accountId}/buildings"

	payload := strings.NewReader("{\n  \"propertyId\": \"<string>\",\n  \"buildingName\": \"<string>\",\n  \"address\": {\n    \"address1\": \"<string>\",\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"address2\": \"<string>\",\n    \"state\": \"<string>\",\n    \"zipcode\": \"<string>\"\n  },\n  \"customId\": \"<string>\",\n  \"buildingClass\": \"<string>\",\n  \"metroArea\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.prophia.com/rest/v2/accounts/{accountId}/buildings")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"propertyId\": \"<string>\",\n  \"buildingName\": \"<string>\",\n  \"address\": {\n    \"address1\": \"<string>\",\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"address2\": \"<string>\",\n    \"state\": \"<string>\",\n    \"zipcode\": \"<string>\"\n  },\n  \"customId\": \"<string>\",\n  \"buildingClass\": \"<string>\",\n  \"metroArea\": \"<string>\"\n}")
  .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::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"propertyId\": \"<string>\",\n  \"buildingName\": \"<string>\",\n  \"address\": {\n    \"address1\": \"<string>\",\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"address2\": \"<string>\",\n    \"state\": \"<string>\",\n    \"zipcode\": \"<string>\"\n  },\n  \"customId\": \"<string>\",\n  \"buildingClass\": \"<string>\",\n  \"metroArea\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "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>"
    }
  ]
}

{
  "error": "Invalid Input",
  "errorCode": "InvalidInput",
  "message": "dba cannot be blank",
  "status": "400 BAD_REQUEST",
  "timestamp": "2026-09-02T20:41:03.118Z",
  "localizedMessage": "dba cannot be blank"
}

{
  "error": "JWT authentication is not supported. Use an API key."
}

{
  "error": "Access Denied",
  "errorCode": "AccessDenied",
  "message": "Not authorized. Missing capabilities: WRITE:DOCUMENT",
  "status": "403 FORBIDDEN",
  "timestamp": "2026-09-02T20:41:03.118Z",
  "localizedMessage": "Not authorized. Missing capabilities: WRITE:DOCUMENT"
}

{
  "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

X-API-Key

string

header

required

Prophia API key — either an account key (grants admin level permissions) or a user key with the REST scope. Send it in the X-API-Key header, or equivalently as Authorization: Bearer <api-key>. JWTs are rejected on /rest endpoints with 401.

Path Parameters

accountId

string

required

Body

application/json

Fields for creating a Building under an existing Property. The address is geocoded on create, which is where the Building's lat and lng come from.

propertyId

string

required

Prophia UUID of Property the building belongs to. This Property must also belong to the api Account. Does not support passing Property.customId for this field.

Minimum string length: 1

buildingName

string

required

Display name for the building.

Minimum string length: 1

address

object

required

Street address of a Building. Prophia geocodes it on create and again whenever it changes, which is where the Building's lat and lng come from. state and zipcode are required for US and CA addresses and optional everywhere else.

Show child attributes

customId

string

Your external identifier, for cross-referencing with your own systems.

buildingType

enum<string>

The asset type for the Building. Must be one of the listed values. Prophia treats it as a reference label only — it is not checked against the asset and does not affect data onboarding. Defaults to OFFICE when omitted.

Available options:

OFFICE,

INDUSTRIAL,

RETAIL,

MIXED_USE,

OTHER,

LIFE_SCIENCES,

MEDICAL_OFFICE,

FLEX

buildingClass

string

Market classification of the building (e.g. A, B, C). This is a subjective, referential value only and has no bearing on how this Building is treated in Prophia's system.

metroArea

string

Metro market the building belongs to. This is a subjective, referential value only and has no bearing on how this Building is treated in Prophia's system.

Response

Representation of a building. All Buildings have one Property association. Multiple Buildings can be associated with the same Property to represent a campus or other multi-building asset.

string

read-only

Prophia internal Building ID (UUID)

propertyId

string

read-only

Pointer to the Property this Building is associated with.

buildingName

string

Display name of the building. Must be unique within the same Property. Can be duplicated with other Buildings in the Account (i.e. Two Properties in the Account can have a Building called 'Building 1').

address

object

Street address of the building.

Show child attributes

onboardingStatus

enum<string>

read-only

How far this building has progressed through Prophia's onboarding process. Leases, BuildingSpaces, and Tags are considered incomplete until onboarding completes for the Building.

Available options:

NOT_STARTED,

INITIAL_SETUP,

ONBOARDING_IN_PROGRESS,

ONBOARDING_COMPLETE

activeStatus

enum<string>

read-only

Operational state of the building record. An ACTIVE status indicates that the building has been fully onboarded and handed off by the Prophia team. An INACTIVE status indicates a Building that will no longer receive updates to its data and is essentially a purely historical representation of the asset. Other statuses show the Building moving through the systems automated processing states and review points.

Available options:

ACTIVE,

INACTIVE,

WORK_IN_PROGRESS,

QA_PENDING,

AI_PROCESSED

customId

string

Your external identifier for the building, for cross-referencing with your own systems. Prophia does not rely on this value in any way.

implementationManager

string

read-only

Prophia implementation manager responsible for onboarding and reviewing the data in this Building. This is not the account manager.

buildingType

enum<string>

The Asset type for the Building. This is a subjective reference value only, is not validated, and does not affect data onboarding.

Available options:

OFFICE,

INDUSTRIAL,

RETAIL,

MIXED_USE,

OTHER,

LIFE_SCIENCES,

MEDICAL_OFFICE,

FLEX

buildingClass

string

Market classification of the building (e.g. A, B, C). This is a subjective reference value only, is not validated, and does not affect data onboarding.

metroArea

string

Metro market the building belongs to (e.g. Seattle Metropolitan Area. This is a subjective reference value only, is not validated, and does not affect data onboarding.

lat

number

read-only

Latitude in decimal degrees. Derived automatically from the address when the building is created and re-geocoded whenever the address is changed; coordinates cannot be supplied directly. A geocode that fails or returns no match leaves the previously stored coordinates in place, so lat/lng may reflect an earlier address; a building whose address has never geocoded successfully has no coordinates at all.

lng

number

read-only

Longitude in decimal degrees. Derived alongside lat from the same geocode, and subject to the same staleness caveat.

propertyType

enum<string>

read-only

Whether the parent property holds a single building or multiple.

Available options:

MULTI_BUILDING,

SINGLE_BUILDING

totalRentableSquareFootage

integer<int32>

read-only

Cached total rentable square footage from the last stacking-plan build; may lag current values while leases are in onboarding. Use the stacking plan for point-in-time occupancy.

squareFootageLeased

integer<int32>

read-only

Cached leased square footage from the last stacking-plan build; may lag current values while leases are in onboarding. For a Building Space to count towards leased square footage it must have either an active/commenced lease or a lease with a future commencement date referencing that space. Use the stacking plan for point-in-time occupancy.

squareFootageOccupied

integer<int32>

read-only

Cached occupied square footage from the last stacking-plan build; may lag current values while leases are in onboarding. For a Building Space to count towards occupied square footage it must have an active/commenced lease referencing that space.Use the stacking plan for point-in-time occupancy.

squareFootageVacant

integer<int32>

read-only

Cached vacant square footage from the last stacking-plan build; may lag current values while leases are in onboarding. For a Building Space to count towards vacant square footage, it can't have any active/commenced lease referencing that space.Use the stacking plan for point-in-time occupancy.

leases

object[]

Leases in this building; only populated when include=leases is present as a request parameter.

Show child attributes

documents

object[]

read-only

Building-level documents (rent rolls, stacking plans); only populated when include=documents is present as a request parameter.

Show child attributes

spaces

object[]

read-only

Spaces in this building, archived and non-archived alike; only populated when include=spaces is present as a request parameter.

Show child attributes

customFields

object[]

read-only

The Building's values for its active Building Custom Fields as name/value pairs, sorted by field name; only populated when include=customFields is present as a request parameter. Manage the fields and assignments themselves through the Custom Fields endpoints.

Show child attributes

Getting Started

API Mechanisms

Data Concepts

Endpoints

Beta

CREATE Building

Authorizations

Path Parameters

Body

Response