Skip to main content
Calendar Resources: Rooms & EquipmentsVersion: v3

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)

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:calendars/resources.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Path Parameters

resourceTypestringrequired

Calendar Resource Type

Available optionsequipmentsrooms
Example:equipments

Query Parameters

locationIdstringrequired

Location ID

Example:ocQHyuzHvysMo5N5VsXc
limitnumberrequired

Maximum number of results

Example:20
skipnumberrequired

Number of results to skip

Example:0

Response

application/json

Calendar resources listed

  • Array items
    • locationIdstringrequired

    Location ID of the resource

    Example:ocQHyuzHvysMo5N5VsXc
    namestringrequired

    Name of the resource

    Example:yoga room
    resourceTypestringrequired

    Type of the calendar resource

    Available optionsequipmentsrooms
    Example:rooms
    isActivebooleanrequired

    Whether the resource is active

    Example:true
    descriptionstring

    Description of the resource

    Example:Spacious yoga studio
    quantitynumber

    Quantity of the resource

    Example:3
    outOfServicenumber

    Indicates if the resource is out of service

    Example:0
    capacitynumber

    Capacity of the resource

    Example:85
    calendarIdsstring[]required

    Calendar IDs

    Example:["Jsj0xnlDDjw0SuvX1J13","oCM5feFC86FAAbcO7lJK"]