Calendar: Get Events By Properties Tool

Usage

All Portia tools using API endpoints that require OAuth are built with plug and play authentication support. They use Portia client credentials including client ID, client name and redirect URL. Such tools will raise a Action Clarification with an OAuth link as the action URL. The portia.wait_for_ready() method must be used in this scenario: Portia's OAuth server will listen for the authentication result and resolve the concerned clarification, allowing your plan run to resume again.

For more on this, please visit to the section on running Portia tools (↗).

Tool details

Tool ID: portia:google:gcalendar:get_events_by_properties

Tool description: Gets Google Calendar events by properties, returning the matching event details. You do not need to provide all the properties, only the ones you have provided with.

Args schema:

{
  "description": "Schema for getting a Google Calendar events by properties.",
  "properties": {
    "event_title": {
      "description": "The title of the event to get",
      "title": "Event Title",
      "type": "string"
    },
    "start_time": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "description": "The earliest time of the events to get in ISO format, e.g 2024-09-20T20:00:00Z",
      "title": "Start Time"
    },
    "end_time": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "description": "The latest time of the events to get in ISO format, e.g 2024-09-20T20:00:00Z",
      "title": "End Time"
    },
    "event_description": {
      "description": "The description of the events to get",
      "title": "Event Description",
      "type": "string"
    },
    "attendees": {
      "description": "The attendees' of the events to get",
      "items": {
        "type": "string"
      },
      "title": "Attendees",
      "type": "array"
    },
    "max_results": {
      "default": 10,
      "description": "The maximum number of events to return",
      "title": "Max Results",
      "type": "integer"
    }
  },
  "required": [
    "event_title",
    "start_time",
    "end_time",
    "event_description",
    "attendees"
  ],
  "title": "GoogleCalendarGetEventsByPropertiesSchema",
  "type": "object"
}

Output schema:

('list[dict]', 'A list of dictionaries containing information about matching calendar events')