List Events | Calendly | Developer Documentation

import { CalendlyClient } from "calendly";
async function main() {
    const client = new CalendlyClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.scheduledEvents.listScheduledEvents({
        group: "https://api.calendly.com/groups/AAAAAAAAAAAAAAAA",
        inviteeEmail: "alice@example.com",
        maxStartTime: "2020-01-02T12:30:00.000000Z",
        minStartTime: "2020-01-02T12:30:00.000000Z",
        organization: "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA",
        sort: "start_time:asc",
        user: "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
    });
}
main();

{
  "collection": [
    {
      "uri": "https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA",
      "name": "15 Minute Meeting",
      "status": "active",
      "start_time": "2019-08-24T14:15:22.123456Z",
      "end_time": "2019-08-24T14:15:22.123456Z",
      "event_type": "https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA",
      "location": {
        "additional_info": "Please check in at the main lobby.",
        "location": "Calendly Office",
        "type": "physical"
      },
      "invitees_counter": {
        "total": 0,
        "active": 0,
        "limit": 0
      },
      "created_at": "2019-01-02T03:04:05.092125Z",
      "updated_at": "2019-01-02T03:04:05.092125Z",
      "event_memberships": [
        {
          "user": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
          "user_email": "user@example.com",
          "user_name": "John Smith",
          "buffered_end_time": "2019-08-24T14:15:22.123456Z",
          "buffered_start_time": "2019-08-24T14:15:22.123456Z"
        }
      ],
      "event_guests": [
        {
          "email": "user@example.com",
          "created_at": "2022-04-21T17:10:48.484945Z",
          "updated_at": "2022-04-21T17:11:01.758636Z"
        }
      ],
      "calendar_event": {
        "kind": "google",
        "external_id": "8suu9k3hj00mni03ss12ba0ce0"
      },
      "meeting_notes_plain": "Internal meeting notes",
      "meeting_notes_html": "<p>Internal meeting notes</p>"
    }
  ],
  "pagination": {
    "count": 20,
    "next_page": "https://api.calendly.com/scheduled_events?count=1&page_token=sNjq4TvMDfUHEl7zHRR0k0E1PCEJWvdi",
    "previous_page": "https://api.calendly.com/scheduled_events?count=1&page_token=VJs2rfDYeY8ahZpq0QI1O114LJkNjd7H",
    "next_page_token": "sNjq4TvMDfUHEl7zHRR0k0E1PCEJWvdi",
    "previous_page_token": "VJs2rfDYeY8ahZpq0QI1O114LJkNjd7H"
  }
}

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.

Required scopes

scheduled_events:read

Authentication

AuthorizationBearer

OAuth 2.0

AuthorizationBearer

Personal Access Token

Query parameters

userstringOptionalformat: "uri"

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

organizationstringOptionalformat: "uri"

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

invitee_emailstringOptionalformat: "email"

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

statusenumOptional

Whether the scheduled event is active or canceled

Allowed values:

sortstringOptional

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_timestringOptionalformat: "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_timestringOptionalformat: "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_tokenstringOptional

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

countintegerOptional1-100Defaults to 20

The number of rows to return

groupstringOptionalformat: "uri"

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

Response

collectionlist of objects

The set of scheduled events matching the criteria

paginationobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error