Skip to main content
GET
GET Property

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
propertyId
string
required

Query Parameters

include
enum<string>[]

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

  • buildings — adds the flat list of buildings under this property.
    • Requires the READ:BUILDING capability.
  • documents — adds the list of property-level documents (e.g. rent rolls, stacking plans) attached at the property scope.
    • Requires the READ:DOCUMENT capability.
Available options:
buildings,
documents

Response

OK

Representation of a Property — the asset grouping directly beneath an Account. A Property holds one or more Buildings; a single Building is the common case, and several Buildings under one Property represent a campus or other multi-building asset. Leases, Building Spaces, and Tags hang off the Buildings rather than the Property itself.

id
string
read-only

Prophia internal Property ID (UUID)

propertyName
string

Display name of the property. Must be unique within the Account, compared without regard to case.

customId
string

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

buildings
object[]

Buildings in this Property; only populated when include=buildings is present as a request parameter. Limited to the Buildings your api key is permitted to access.

documents
object[]
read-only

Documents filed against the Property itself rather than against any of its Leases; only populated when include=documents is present as a request parameter.