Resources.calendars: list

Retrieves a list of calendar resources for an account. Try it now.


HTTP request



Parameter name Value Description
Path parameters
customer string The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
Optional query parameters
maxResults integer Maximum number of results to return. Acceptable values are 1 to 500, inclusive.
orderBy string Field(s) to sort results by in either ascending or descending order. Supported fields include resourceId, resourceName, capacity, buildingId, and floorName. If no order is specified, defaults to ascending. Should be of the form "field [asc|desc], field [asc|desc], ...". For example buildingId, capacity desc would return results sorted first by buildingId in ascending order then by capacity in descending order.
pageToken string Token to specify the next page in the list.
query string String query used to filter results. Should be of the form "field operator value" where field can be any of supported fields and operators can be any of supported operations. Operators include '=' for exact match and ':' for prefix match or HAS match, depending on type of field.

For ':', when the field supports a scalar value, such as a String, and the value is followed by an asterisk (*), the query is considered a prefix match. In a prefix match, the value must be at the start of a string to be a match. For example, resourceName:Conference* returns all strings whose resourceName starts with "Conference," such as "Conference-Room-1."

For ':', when the field supports repeated values, such as featureInstances[].features, use a colon (:) without an asterisk (*) to indicate a HAS match. For example, would return any calendar resource that has a feature instance whose name is "Phone" (all rooms with phones).

An asterisk (*) is only valid at end of value, it cannot be used at start or middle of value. For example, resourceName:*Room* doesn't work. Query strings are case sensitive.

Supported fields include generatedResourceName, resourceName, name, buildingId,


This request requires authorization with at least one of the following scopes:


For more information, see the authentication and authorization page.

Request body

Do not supply a request body with this method.


If successful, this method returns a response body with the following structure:

  "kind": "admin#directory#resources#calendars#calendarResourcesList",
  "etag": etag,
  "nextPageToken": string,
  "items": [
    resources.calendars Resource
Property name Value Description Notes
kind string Identifies this as a collection of CalendarResources. This is always admin#directory#resources#calendars#calendarResourcesList.
etag etag ETag of the resource.
nextPageToken string The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
items[] list The CalendarResources in this page of results.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.