Sign in

v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB
Resources

Retrieve single resource.

Retrieve single resource.

Required scopes: flex.space.resources.read

get/api/v2/organizations/{orgSlug}/resources/{resourceId}

Path parameters

resourceIdstring required

resource id

orgSlugstring required

organization slug

Response

propertiesobject

An object that contains all custom properties that can be applied to the item.

_idstring

The unique identifier of the resource.

namestring

The name of the resource.

descriptionstring

A detailed description of the resource.

typestring

The type of the resource. Resource types can be extended and customized, but the default system types are: "meeting_room" (bookable meeting rooms), "team_room" (assignable private offices), "desk" (assignable dedicated desks), "desk_tr" (assignable office desks within private offices), "hotdesk" (bookable hot desks), and "desk_na" (not available desks).

ratestring

The resource rate used for pricing bookings for this resource. Contains pricing rules, amenities, and booking configuration.

locationstring

The location the resource is assigned to.

floorstring

The floorplan where the resource is located within the location.

pricenumber

The monthly price for assigning this resource. Only applicable to assignable resources (resource types with "Can assign" enabled), such as dedicated desks, office desks, and private offices. Used for monthly billing.

depositnumber

The deposit amount required when assigning this resource. Only applicable to assignable resources.

sizenumber

The capacity of the resource, representing the number of people that can use or occupy the resource simultaneously.

areanumber

The physical area of the resource measured in square millimeters.

childrenCountnumber

The count of available child resources associated with this parent resource. For example, the number of office desks (desk_tr) within a private office (team_room). This value is dynamically calculated and updated to reflect available children only.

desksCountnumber

The total number of desks within this resource. Typically used for tracking desk inventory in private offices or other parent resources.

parentsstring[]

An array of parent resource IDs for hierarchical resources. Used for resources that can have multiple parents, such as meeting rooms that belong to multiple zones. Newer resources use this property instead of the single "parent" field.

availabilityobject

Defines the time period during which the resource is available for booking or assignment. Contains "startDate" (when availability begins) and "endDate" (when availability ends, or null for indefinite availability). Multiple availability periods can be configured.

targetPlanstring

The target plan ID associated with this resource (for monthly billed resources).

imagesstring[]

An array of image URLs associated with this resource, used for displaying resource photos in listings and detail views.

amenitiesstring[]

An array of amenity IDs associated with this resource. Amenities can be defined directly on the resource or inherited from its resource rate (e.g., WiFi, projector, whiteboard, coffee machine).

privacy'full' | 'active_members' | 'limited'

The privacy level of the resource, which determines who can view or book it. Available only for bookable resources. Possible values: "limited" (restricted to specific members, teams, or plans; if empty, only admins have access), "full" (public access for members, non-members, guests, and visible on the public calendar), and "active_members" (restricted to active members only).

limitedToobject

Limited entities for resources with privacy "limited". Contains company IDs and plan IDs that can access the resource.

createdAtstring date-time

The timestamp when the resource was created.

createdBystring

The ID of the user who created the resource.

modifiedAtstring date-time

The timestamp when the resource was last updated.

modifiedBystring

The ID of the user who last updated the resource.

Example response

{
  "properties": {
    "customProperty1": "value1",
    "customProperty2": "value2"
  },
  "_id": "603dfbc260f4054084125d39",
  "name": "Resource 1",
  "description": "Resource Description",
  "type": "team_room",
  "rate": "603dfbc260f4054084125d39",
  "location": "603dfbc260f4054084125d39",
  "floor": "603dfbc260f4054084125d39",
  "price": 50,
  "deposit": 30,
  "size": 7,
  "area": 39483789.47303743,
  "childrenCount": 7,
  "desksCount": 2,
  "parents": [],
  "availability": {
    "startDate": "2018-01-01T00:00:00.000Z",
    "endDate": null
  },
  "targetPlan": "603dfbc260f4054084125d39",
  "images": [],
  "amenities": [],
  "limitedTo": {
    "companies": [
      "603dfbc260f4054084125d39"
    ],
    "plans": [
      "603dfbc260f4054084125d40"
    ]
  },
  "createdAt": "2022-02-07T10:03:33.169Z",
  "createdBy": "603dfbc260f4054084125d39",
  "modifiedAt": "2022-02-08T10:03:33.169Z",
  "modifiedBy": "603dfbc260f4054084125d39"
}