Skip to main content
GET
LIST Building

Filters

Filters combine with AND: a result must match every filter you supply.

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

Query Parameters

include
enum<string>[]

Optional collections to populate. Unknown keys are rejected with 400.

  • leases — adds the list of leases under this building.
    • Requires the READ:LEASE capability.
  • documents — adds the list of building-level documents (e.g. rent rolls, stacking plans) attached at the building scope.
    • Requires the READ:DOCUMENT capability.
  • spaces — adds the list of suites/spaces (archived and non-archived) attached to this building.
    • Requires the READ:BUILDING_SPACE capability.
  • customFields — adds the building's values for its active Building Custom Fields, sorted by field name.
    • Requires the READ:CUSTOM_FIELD capability.
Available options:
leases,
documents,
spaces,
customFields
page
integer<int32>
default:0

0-based page index. Negative values are clamped to 0.

limit
integer<int32>
default:50

Page size. Values outside 1–200 are clamped, not rejected; check the response's limit for the value actually applied.

sortBy
enum<string>
default:buildingName

Sort field. Defaults to buildingName; unrecognized values silently fall back to the default.

Available options:
buildingName,
address.city,
address.state,
activeStatus,
customId,
buildingType,
implementationManager,
createdAt
sortDir
string
default:asc

Sort direction: asc (default) or desc. Any other value is treated as asc.

Filter
name
string

Case-insensitive contains match on the building name.

Filter
city
string

Case-insensitive exact match on the address city.

Filter
state
string

Case-insensitive exact match on the address state.

Filter
activeStatus
enum<string>

Filter by the building's active status. Matching is case-insensitive; an unrecognized value returns no results.

Available options:
ACTIVE,
INACTIVE,
WORK_IN_PROGRESS,
QA_PENDING,
AI_PROCESSED
Filter
customId
string

Exact match on the building's custom id.

Filter
buildingType
enum<string>

Filter by building type. Matching is case-insensitive; an unrecognized value returns a 400.

Available options:
OFFICE,
INDUSTRIAL,
RETAIL,
MIXED_USE,
OTHER,
LIFE_SCIENCES,
MEDICAL_OFFICE,
FLEX
Filter
implementationManager
string

Case-insensitive contains match on the implementation manager's name.

Filter
customFields
string[]
READ:CUSTOM_FIELD

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

totalCount
integer<int64>

Total number of items matching the request across all pages.

page
integer<int32>

0-based index of this page.

limit
integer<int32>

Page size actually applied — requested values outside 1–200 are clamped.

items
object[]

The Buildings on this page of results.

hasMore
boolean

True when more pages exist after this one. Iterate on this rather than computing page counts from totalCount, which can change between requests.