Resources

The resource objects describe all type of bookable (short term bookings or long term assignments) resources in the system.

Resource types can be extended and modified, but the default ones are:

  • meeting rooms - meeting_room
  • private offices - team_room
  • private office desk - desk_tr
  • dedicated desks - desk
  • hot desks - hotdesk

You can retrieve individual resources as well as a list of all your resources or all of a specific type.

Resource

PropertyTypeRequiredDescription
namestringtrueThe name of the resource in hand.
rateRatefalseThe resource rate used for pricing bookings for this particular resource.
officeLocationtrueThe location the resource is assigned to.
roomFloortrueThe floorplan the resource is assigned to.
typeenumtrueThe type of the resource. One of the types listed above.
availabilityarray of objectstrueContains a single object with two parameters - startDate and endDate. The two dates determine the availability of the resourcee. The "endDate" parameter can be set to null if the resource is available indefinitely.
access.fullbooleanfalseAvailable only for bookable resources. Determines whether a resource is publicly available to non-members and members.
access.publicbooleanfalseAvailable only for bookable resources. Determines whether a resource is available to active members.
access.teamsbooleanfalseAvailable only for bookable resources. Determines whether a resource is visible only to specific companies.
access.plansbooleanfalseAvailable only for bookable resources. Determines whether a resource is visible only to companies and members who've been assigned a specific plan.
parentsarrayfalseArray of resource ids which are parents of the current resource. Parents are only present for resource types with hierarchicalResourcesEnabled option set to true.
createdAtdatereadonlyThe date when the resource has been created.
createdByidreadonlyThe user that created the resource.