Skip to main content
GET
GET Building Space

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
buildingId
string
required
spaceId
string
required

Response

OK

Representation of a space or unit in a Building. Some example uses: a rentable suite, a conference room, storage space, or a full floor.

id
string
read-only

Prophia internal Building Space ID (UUID).

buildingId
string
read-only

The buildingId (UUID) of the Building this space belongs to.

floor
string

Floor the space sits on. This value primarily affects the grouping of Building Spaces in the Stacking Plan, but also governs which spaces have floor level encumbrances applied to them. For example if a ROFO Tag's offeredSpace component references 'FLOOR1' as its encumbranceSpaces value, all spaces having space.floor=1 will show as encumbered in the Stacking Plan.

suiteNumber
string

Canonical name of the space. This is the value that Tag applicableSpaces entries match against, by string — renaming it breaks those associations.

squareFootage
integer<int32>

Rentable square footage of the space.

type
enum<string>

What kind of unit this is. This is a referential value and does not affect how a space operates in the system.

Available options:
Office,
Retail,
Industrial,
Storage,
Telecom,
Parking,
Conference Room,
Lobby,
Elevator,
Fitness Center,
License Agreement,
Management Office,
Amenity,
Cafe,
Bike Storage,
Lounge,
Other,
zSuite
rentable
boolean

Whether the space counts as rentable inventory. If marked as non-rentable, the space and leases associated with it, if you've chosen to continue associating leases with the space, may cease being present in reports like the Rent Roll. Marking a space as non-rentable is normally used in cases like Lobbies, Elevators, and like shared public spaces of the Building that are not eligible to be leased.

archived
boolean

Archived spaces still appear in listings unless filtered with archived=false. It's best to archive a Building Space when it is referenced by historical leases but is no longer representative of a discrete space in the Building.

createdAt
string<date-time>
read-only

When the space was created.

updatedAt
string<date-time>
read-only

When the space was last modified.

occupied
boolean

An override value: Allows the space to be marked as occupied, even when lacking an active lease associated with the space. A value of false does not mean that there are no associated active leases, only that the override is not currently marking the space as occupied. Best used for spaces that are not traditionally leased but you still want to show as occupied in the Stacking Plan and count towards occupied square footage statistics.