List Calendar Resources

GET 
/calendars/resources/:resourceType

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

List calendar resources by resource type and location ID (Services V1)

Request

Version stringrequired

API Version

Available optionsv3

resourceType stringrequired

Calendar Resource Type

Available optionsequipmentsrooms

locationId stringrequired

Location ID

limit numberrequired

Maximum number of results

skip numberrequired

Number of results to skip

application/json

Calendar resources listed

application/json

Schema

Schema

• Array [
locationIdstringrequired

Location ID of the resource

namestringrequired

Name of the resource

resourceTypestringrequired
Type of the calendar resource
Available optionsequipmentsrooms
isActivebooleanrequired

Whether the resource is active

descriptionstring

Description of the resource

quantitynumber

Quantity of the resource

outOfServicenumber

Indicates if the resource is out of service

capacitynumber

Capacity of the resource

calendarIdsstring[]required

Calendar IDs

• ]

Example (auto)

[
  {
    "locationId": "ocQHyuzHvysMo5N5VsXc",
    "name": "yoga room",
    "resourceType": "rooms",
    "isActive": true,
    "description": "Spacious yoga studio",
    "quantity": 3,
    "outOfService": 0,
    "capacity": 85,
    "calendarIds": [
      "Jsj0xnlDDjw0SuvX1J13",
      "oCM5feFC86FAAbcO7lJK"
    ]
  }
]