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
| Property | Type | Required | Description |
|---|---|---|---|
| name | string | true | The name of the resource in hand. |
| rate | Rate | false | The resource rate used for pricing bookings for this particular resource. |
| office | Location | true | The location the resource is assigned to |
| room | Floor | true | The floorplan the resource is assigned to |
| size | number | false | The capacity of the resource. This applies only for resource types, that are of type "Zone". Desks don't have a capacity. |
| area | number | false | The area of the resource in square milimeters. |
| type | enum | true | The type of the resource. One of the types listed above. |
| parents | array | false | Array of resource ids which are parents of the current resource. Parents are only present for resource types with hierarchicalResourcesEnabled option set to true. |
| createdAt | date | readonly | The date when the resource has been created. |
| createdBy | id | readonly | The user that created the resource. |