Skip to content

Organization

An organization is the tenant, usually a company or other legal entity. Everything on the platform belongs to exactly one, pointed at by owner_id.

Organizations nest to model internal structure. The parent is the company, the children are departments, units, teams or whatever shape the user wants. Each child owns its own subtree and can't see its siblings. A property manager or a facilities group is a child, not a tenant.

What an organization owns

ResourceWhat it is
LocationsPhysical sites
BookablesThings you can book
Bookable typesClassifications for bookables
CapabilitiesFeatures attached to bookables and other objects
BookingsReservations on bookables
CheckinsArrivals and departures against bookings
ClaimsAccess grants
CodesScannable identifiers
TimeslotsScheduling windows
ActionsServer side code bound to triggers
AssetsFiles and images

Reading at the organization level

The organization endpoints can return just that organization's resources, or walk the tree and return everything inside it. Pass ?inherits=true on any endpoint that supports it to roll up children. Default is the single org.

GET /organization/{id}/booking lists bookings on the org's bookables, or across the whole subtree with inherits=true.

GET /organization/{id}/calendar expands recurrence over the same scope.

GET /organization/{id}/available returns the total free time over the same scope. Most clients use the location level instead since "free rooms in this building" is the more common question.

Same composition as anywhere else, see Calendar and Availability.

API

See the Organization tag for CRUD, the three views above, owned claims and assets, search, applied timeslots and bound actions.