scheduledEvents

List Events

Returns a list of Events.

  • Pass organization parameter to return events for that organization (requires admin/owner privilege)
  • Pass user parameter to return events for a specific User
  • Pass group parameter to return events for a specific Group (requires organization admin/owner or group admin privilege)

NOTES:

  • If you are the admin/owner of the organization, you can use both organization and user to get a list of events for a specific user within your organization.

  • If you are the admin/owner of the organization, you can use both organization and group to get a list of events for a specific group within your organization.

  • user can only be used alone when requesting your own personal events. This will return your events within any organization that you are currently in or were a part of in the past.

<Info title="Required scopes"> > `scheduled_events:read` </Info>
get/scheduled_events

Request

  • Base URL: https://api.calendly.com
  • URL: https://api.calendly.com/scheduled_events
  • Auth: HTTP bearer

Query parameters

userstring uri

Return events that are scheduled with the user associated with this URI

organizationstring uri

Return events that are scheduled with the organization associated with this URI

invitee_emailstring email

Return events that are scheduled with the invitee associated with this email address

status'active' | 'canceled'

Whether the scheduled event is active or canceled

sortstring

Order results by the specified field and direction. Accepts comma-separated list of {field}:{direction} values. Supported fields are: start_time. Sort direction is specified as: asc, desc.

min_start_timestring date-time

Include events with start times after this time (sample time format: "2020-01-02T03:04:05.678123Z"). This time should use the UTC timezone.

max_start_timestring date-time

Include events with start times prior to this time (sample time format: "2020-01-02T03:04:05.678123Z"). This time should use the UTC timezone.

page_tokenstring

The token to pass to get the next or previous portion of the collection

countinteger

The number of rows to return

groupstring uri

Return events that are scheduled with the group associated with this URI

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.