SavvyCal API
Endpoints
Resources
Webhooks
SavvyCal API
Home

Events

Endpoints for listing and fetching individual events.

List Events

This endpoint allows you to list your events scheduled via SavvyCal.

GET
/v1/events

Parameters

Name Type Description
state string Filter the query by event state (either confirmed, canceled, or all). Defaults to confirmed.
period string Filter the query by when events occur (either past, upcoming, or all). Defaults to upcoming.
before string A pagination cursor for entries before a specific point in the collection.
after string A pagination cursor for entries after a specific point in the collection.
limit string The maximum number of entries to retrieve (defaults to 20, up to 100 allowed).

Response

200
OK

When successful, returns a Paginated List of Event resources.

{
"entries": [
// items
],
"metadata": {
"before": nil,
"after": "g3QAAAABZAACaWRiAAAbFA==",
"limit": 20
}
}

Get Event

This endpoint allows you to fetch a single event.

GET
/v1/events/:event_id

Response

200
OK

When successful, returns an Event resource.

{
"id": "event_01ED74HMFGVZ92YVCWTD8Y8H6X",
// ...
}
404
Not Found

It the resource does not exist or is not accessible, returns a not found response.

Create Event

This endpoint allows you to create an event for a given scheduling link.

Note about time slots: You’ll only be able to create events that match an available time slot for the underlying scheduling link. You can use the List Available Slots endpoint to query for time slots.

Note about conferencing: For some conferencing providers (like Zoom), the meeting information is not guaranteed to appear in the response body. If our initial attempt to create the meeting room fails, we will retry and attach the information to event later.

POST
/v1/links/:link_id/events

Parameters

Name Type Description
display_name * string The scheduler’s full name.
email * string The scheduler’s email address.
start_at * datetime The ISO-8601 timestamp when the event starts.
end_at * datetime The ISO-8601 timestamp when the event ends.
time_zone * string The scheduler’s local Olsen time zone.
fields array A list of custom fields.
↳ id string The field ID.
↳ type string The field type.
↳ label string The field label.
↳ value string The field value submitted by the attendee.
metadata object An object containing custom metadata attached to the event.

Response

200
OK

When successful, returns the new Event resource.

{
"id": "event_01ED74HMFGVZ92YVCWTD8Y8H6X",
// ...
}
422
Unprocessible Entity

If any of the parameters are invalid, returns validation errors.

{
"errors": {
"display_name": ["is required"]
}
}