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
| 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 | false | 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. |
| target | read-only | true | The _id of the floor plan object to which the resource is associated. This shouldn't be edited apart from adjusting your floor plan through the admin UI. |
| targetPlan | Plan | true | The _id of the plan associated with the resource, if it's an assignable resource. This determines the plan that will be used when assigning a membership for the resource. |
| price | number | false | A price can be set only for a resource that is assignable, i.e. its resource type has "Can assign" enabled. This parameter takes precedence over the targetPlan one. |
| availability | array of objects | true | Contains 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.full | boolean | false | Available only for bookable resources. Determines whether a resource is publicly available to non-members and members. |
| access.public | boolean | false | Available only for bookable resources. Determines whether a resource is available to active members. |
| access.teams | boolean | false | Available only for bookable resources. Determines whether a resource is visible only to specific companies. |
| access.plans | boolean | false | Available only for bookable resources. Determines whether a resource is visible only to companies and members who've been assigned a specific plan. |
| 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. |
| status | string | false | This reflects the status of assignable resources i.e. their resource type has "Can assign" enabled. The value can be either available, occupied or available_soon (becomes available within 3 calendar months) |
| ownStatus | stringe | false | This property appears only for parent resources that have children resources, e.g. a private office with office desks associated with it. It's possible to partially occupy a private office by assigning only some of its desks, instead of assigning the whole office. This parameter is meant to represent the office's own status, rather than of its desks. Example: If a private office has two children office desks and one of it is occupied its "ownStatus" parameter will be set to "available", whereas the "status" parameter will be "partially_occupied". |
| createdAt | date | readonly | The date when the resource has been created. |
| createdBy | id | readonly | The user that created the resource. |