v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB

Resources

Retrieve all resources.

Required scopes: flex.space.resources.read

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

Path parameters

orgSlugstring required

organization slug

Query parameters

_idstring

Example:603dfbc260f4054084125d39

Filter by unique resource identifier.

namestring

Example:Resource 1

Filter by exact name of the resource.

locationstring

Example:603dfbc260f4054084125d39

Filter by the location the resource is assigned to.

typestring

Filter by 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). Supports both single type values (e.g., type=meeting_room) and array operations (e.g., type[$in]=meeting_room,team_room). To get the available type values for filtering, retrieve them from the "type" property returned by the GET /resource-types endpoint.

modifiedAtstring

Example:modifiedAt[$gte]=YYYY-MM-DDTHH:mm:ssZ

Filter by the modified date. Supports date comparison filters: $gt, $gte, $lt, $lte

createdAtstring

Example:createdAt[$gte]=YYYY-MM-DDTHH:mm:ssZ

Support date comparison filters: $gt, $gte, $lt, $lte

$selectstring

Example:recipient,sender

Select fields to return

$cursorNextstring

$cursorPrevstring

$limitnumber

Response

rangeStartnumber

rangeEndnumber

cursorNextstring

cursorPrevstring

Example response

{
  "results": [
    {
      "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"
    }
  ]
}