SAsavvycal
Events

List events

When any filter value is invalid, such as an unparseable date, every filter uses its default.

get/v1/events

Request

Query parameters

limitinteger
afterstring

Returns the entries after this cursor, from metadata.after in a previous response.

beforestring

Returns the entries before this cursor, from metadata.before in a previous response.

state'all' | 'any' | 'confirmed' | 'canceled' | 'awaiting_reschedule' | 'awaiting_checkout' | 'checkout_expired' | 'awaiting_approval' | 'declined' | 'tentative'

tentative matches awaiting_checkout, awaiting_approval, and awaiting_reschedule events. canceled matches canceled and declined events. all and any match every state.

Defaults to awaiting_approval when the current user has events awaiting their approval, and confirmed otherwise.

period'past' | 'upcoming' | 'fixed' | 'all'

fixed matches events that overlap the dates from from through until, and applies no time filter unless both are given.

fromstring date

The first date of the range, from the start of the day in time_zone (when period is fixed).

untilstring date

The last date of the range, through the end of the day in time_zone (when period is fixed).

time_zonestring

The IANA time zone ID for the from and until dates. Defaults to the current user's time zone, which also applies when the ID is unknown.

qstring

Search text. Matches the event summary, description, link name and description, and attendee names and emails.

direction'asc' | 'desc'

Sort direction by start time.

attendance'attending' | 'any'

attending matches events the current user attends. any matches every event the user can access.

linkstring

A link ID, or any for every link.

Response

Success

Example response

{
  "entries": [
    {
      "canceled_at": null,
      "rescheduled_at": null,
      "location_settings": [
        {
          "instance_id": "1234567890",
          "type": "zoom"
        }
      ],
      "description_settings": {
        "include_attendees": true,
        "include_fields": false,
        "include_link_name": true
      },
      "location": "Zoom meeting",
      "buffer_before": 15,
      "additional_info": "Please prepare project overview",
      "duration": 30,
      "uuid": "550e8400-e29b-41d4-a716-446655440000",
      "reschedule_reason": null,
      "conferencing": {
        "instructions": "Click the link to join",
        "join_url": "https://zoom.us/j/123456789",
        "meeting_id": "123456789",
        "type": "zoom"
      },
      "link": {
        "description": "<p>Discussing project requirements</p>",
        "id": "link_01J5KC2G3MHPCECSQ6KM6FMDPC",
        "name": "30 Minute Meeting",
        "private_name": null,
        "slug": "30min"
      },
      "poll": null,
      "summary": "30 Minute Meeting with John Doe",
      "original_end_at": null,
      "description": "<p>Discussing project requirements</p>",
      "id": "event_01KKGY70MFPCECSQ6KM6FMDPC3",
      "cancel_reason": null,
      "organizer": {
        "display_name": "John Doe",
        "email": "john@example.com",
        "fields": [],
        "first_name": "John",
        "id": "attendee_01J5KCPP3XKRFGT8V2WD9Y8H6X",
        "is_organizer": true,
        "last_name": "Doe",
        "marketing_opt_in": false,
        "phone_number": null,
        "response_status": "accepted",
        "time_zone": "America/New_York"
      },
      "is_group_session": false,
      "original_start_at": null,
      "start_at": "2024-01-20T14:00:00Z",
      "url": "https://savvycal.com/events/event_01KKGY70MFPCECSQ6KM6FMDPC3",
      "payment": {
        "amount_total": 1000,
        "state": "paid",
        "url": "https://dashboard.stripe.com/acct_XYZ/payments/xxxxxxxxx"
      },
      "maximum_group_size": 1,
      "end_at": "2024-01-20T14:30:00Z",
      "state": "confirmed",
      "attendees": [
        {
          "display_name": "John Doe",
          "email": "john@example.com",
          "fields": [],
          "first_name": "John",
          "id": "attendee_01J5KCPP3XKRFGT8V2WD9Y8H6X",
          "is_organizer": true,
          "last_name": "Doe",
          "marketing_opt_in": false,
          "phone_number": null,
          "response_status": "accepted",
          "time_zone": "America/New_York"
        },
        {
          "display_name": "Jane Smith",
          "email": "jane@example.com",
          "fields": [],
          "first_name": "Jane",
          "id": "attendee_01J5KCRR5ZKRFGT8V2WD9Y8H6X",
          "is_organizer": false,
          "last_name": "Smith",
          "marketing_opt_in": true,
          "phone_number": "+1234567890",
          "response_status": "accepted",
          "time_zone": "America/New_York"
        }
      ],
      "scheduler": {
        "display_name": "Jane Smith",
        "email": "jane@example.com",
        "fields": [],
        "first_name": "Jane",
        "id": "attendee_01J5KCRR5ZKRFGT8V2WD9Y8H6X",
        "is_organizer": false,
        "last_name": "Smith",
        "marketing_opt_in": true,
        "phone_number": "+1234567890",
        "response_status": "accepted",
        "time_zone": "America/New_York"
      },
      "scope": {
        "id": "scope_01J5KC4R7NHQFGT8V2WD9Y8H6X",
        "name": "Sales Team",
        "slug": "sales"
      },
      "buffer_after": 0,
      "metadata": {},
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "metadata": {
    "after": "eyJpZCI6ImV2ZW50X2FiYzEyMyJ9",
    "before": null,
    "limit": 25
  }
}

Changes

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