Skip to main content
GET
GET Building

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

buildingId
string
required

Accepts the Prophia ID or your own custom ID. A custom ID is looked up in the account your API key belongs to.

Response

OK

id
string
address
object
customId
string
buildingName
string
leases
object[]
onboardingStatus
enum<string>
Available options:
NOT_STARTED,
INITIAL_SETUP,
ONBOARDING_IN_PROGRESS,
ONBOARDING_COMPLETE
activeStatus
enum<string>
Available options:
ACTIVE,
INACTIVE,
WORK_IN_PROGRESS,
QA_PENDING,
AI_PROCESSED