Search Rooms

Search for rooms and other resources in your Google Calendar account.

Options

Field Definition Type Required
Result Set Determine the number of items in the search results:
  • First Room: Returns the first room from the search results.
  • All Rooms: Returns all room based on the search criteria.
Dropdown TRUE
Filter Select an operator to limit the search results:
  • No Filter: No input field is added to the Search Rooms card. Returns all records.

  • Starts With: String value for a prefix match. The string value should always be followed by a *.

  • Equal: String values in a room name that must be included in the search results. Cannot be partial string values.

  • Not Equal: String values in a room name that must be excluded from the search results. Can be partial string values.

A filter is set against searches in the following fields:

  • Generated Name

  • Name

  • Building ID

  • Floor Name

  • Capacity

  • Feature Instances

  • Email (for resources)

  • Category

Dropdown TRUE

Input

Field Definition Type Required
Filters (for the option Starts With)
Generated Name Read-only auto-generated name of the room which includes metadata about the resource such as building name, floor, capacity, and so forth. For example, NYC-2-Training Room 1A (16). String FALSE
Name Name of the calendar resource. For example, Training Room 1A. String FALSE
Filters (for the options Equal and Not Equal)
Generated Name Read-only auto-generated name of the room which includes metadata about the resource such as building name, floor, capacity, and so forth. For example, NYC-2-Training Room 1A (16). String FALSE
Name Name of the calendar resource. For example, Training Room 1A. String FALSE
Building ID Unique ID for the building in which a room is located. String FALSE
Floor Name Name of the floor on which the room is located. String FALSE
Capacity Capacity of a room, number of seats in a room. Number FALSE
Feature Name (for the options Equal only) Name of a feature for the room. String FALSE
Email Read-only email for the room resource. String FALSE
Category Category of the calendar resource. Options are:
  • CONFERENCE_ROOM

  • OTHER

  • CATEGORY_UNKNOWN

Legacy data is set to CATEGORY_UNKNOWN.

Dropdown FALSE
Note

If input fields are left blank, the search results will return all calendar rooms.

Output

Field Definition Type
Rooms
Email Read-only email for the room resource. String
Generated Name Read-only auto-generated name of the room which includes metadata about the resource such as building name, floor, capacity, and so forth. For example, NYC-2-Training Room 1A (16). Object
Name Name of the calendar resource. For example, Training Room 1A. Object
User Visible Description Description of the room, visible to users and admins. Object
Description Description of the room, visible only to admins. Object
Kind Type of resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource. Object
Etags ETag of the room resource. Object
Type Type of data returned. Object
Category Category of the calendar resource. Either CONFERENCE_ROOM or OTHER. Legacy data is set to CATEGORY_UNKNOWN. Object
Feature Instances Instances of features for the room. List of Objects
Feature Name of a feature for the room. Object
ID Unique ID for the room. Object
Capacity Capacity of a room, number of seats in a room. Object
Floor Name Name of the floor on which the room is located. Object
Building ID Unique ID for the building in which a room is located. Object
Floor Section Name of the section within a floor in which the room is located. Object

Related topics

Google Calendar connector

About the elements of Okta Workflows

Google Calendar API documentation