Calendar events across all connected accounts in a time window
const url = 'http://localhost:11044/api/v1/calendar/events?days=7';const options = {method: 'GET', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'http://localhost:11044/api/v1/calendar/events?days=7' \ --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Length of the window in days, starting now and running forward, so past events are never included; defaults to 7, 0 gives a zero-length window, and a negative value is a 400. No upper limit is applied
Responses
Section titled “Responses”Days is negative. The reason is carried in the body’s error field, alongside an empty events list
Calendar events from GET /calendar/events, or why they could not be read
object
Why no events were returned: a negative days, or the calendar providers could not be read. Null on success
Events from every connected calendar account between now and days days ahead, merged and sorted by start. A provider that fails is skipped rather than reported. Empty when error is set
One instance of an event on a calendar of the signed-in user’s connected accounts; a recurring meeting arrives as one entry per occurrence. Returned in the events list of GET /calendar/events.
object
The connected account the event was read from; set on every event GET /calendar/events returns
object
The provider’s stable identifier for the account, typically its email address
Label recorded for the account when it was connected, for showing in a UI
Key of the OAuth provider the account was connected through, such as google-workspace
Everyone invited, people and resources alike; empty when the event has no guest list
One person or resource invited to a calendar event, as the provider lists them. Found in a CalendarEvent’s attendees and organizer on GET /calendar/events.
object
Name the provider shows for the attendee; null when it has none
The attendee’s email address as the provider lists it; empty when the provider gave none
True when the invitation marks this attendee optional
True when the provider marks this attendee as the event’s organizer
True for a booked room or device rather than a person
This attendee’s reply to the invitation; NEEDS_ACTION when the provider reports no reply
The provider’s id of the calendar holding the event; one account can have several calendars
Event description or agenda as the provider stores it, which may contain HTML; empty when there is none
End of the event, an ISO-8601 instant, exclusive; one hour after start when the provider gave no end
The provider’s id for this event instance
True for an all-day event, which has a date but no time of day
True when this is one occurrence of a recurring series
Video-call link: the provider’s structured conference link, else a legacy Meet link, else the first http(s) URL in the location; null when none is found
Location text as the provider gives it, a place name or an address; null when absent or blank
The signed-in user’s reply, from their own attendee entry. With no such entry it is ACCEPTED when the event has no guests or they organized or created it, otherwise NEEDS_ACTION
The organizer, from the provider’s organizer field or else the attendee marked as organizer; null when there is neither
object
Name the provider shows for the attendee; null when it has none
The attendee’s email address as the provider lists it; empty when the provider gave none
True when the invitation marks this attendee optional
True when the provider marks this attendee as the event’s organizer
True for a booked room or device rather than a person
This attendee’s reply to the invitation; NEEDS_ACTION when the provider reports no reply
Start of the event, an ISO-8601 instant. For an all-day event, midnight at the start of its date in the event’s time zone
Time-zone id the event is scheduled in, such as Europe/London, for display; the calendar’s own zone when the event names none or an unknown one
Event title; (no title) when the provider has none
Link to the event in the provider’s web UI; null when the provider gives none
The provider’s visibility setting for the event; DEFAULT when it sets none or a value not listed
The calendar providers could not be read. The reason is carried in the body’s error field, alongside an empty events list
Calendar events from GET /calendar/events, or why they could not be read
object
Why no events were returned: a negative days, or the calendar providers could not be read. Null on success
Events from every connected calendar account between now and days days ahead, merged and sorted by start. A provider that fails is skipped rather than reported. Empty when error is set
One instance of an event on a calendar of the signed-in user’s connected accounts; a recurring meeting arrives as one entry per occurrence. Returned in the events list of GET /calendar/events.
object
The connected account the event was read from; set on every event GET /calendar/events returns
object
The provider’s stable identifier for the account, typically its email address
Label recorded for the account when it was connected, for showing in a UI
Key of the OAuth provider the account was connected through, such as google-workspace
Everyone invited, people and resources alike; empty when the event has no guest list
One person or resource invited to a calendar event, as the provider lists them. Found in a CalendarEvent’s attendees and organizer on GET /calendar/events.
object
Name the provider shows for the attendee; null when it has none
The attendee’s email address as the provider lists it; empty when the provider gave none
True when the invitation marks this attendee optional
True when the provider marks this attendee as the event’s organizer
True for a booked room or device rather than a person
This attendee’s reply to the invitation; NEEDS_ACTION when the provider reports no reply
The provider’s id of the calendar holding the event; one account can have several calendars
Event description or agenda as the provider stores it, which may contain HTML; empty when there is none
End of the event, an ISO-8601 instant, exclusive; one hour after start when the provider gave no end
The provider’s id for this event instance
True for an all-day event, which has a date but no time of day
True when this is one occurrence of a recurring series
Video-call link: the provider’s structured conference link, else a legacy Meet link, else the first http(s) URL in the location; null when none is found
Location text as the provider gives it, a place name or an address; null when absent or blank
The signed-in user’s reply, from their own attendee entry. With no such entry it is ACCEPTED when the event has no guests or they organized or created it, otherwise NEEDS_ACTION
The organizer, from the provider’s organizer field or else the attendee marked as organizer; null when there is neither
object
Name the provider shows for the attendee; null when it has none
The attendee’s email address as the provider lists it; empty when the provider gave none
True when the invitation marks this attendee optional
True when the provider marks this attendee as the event’s organizer
True for a booked room or device rather than a person
This attendee’s reply to the invitation; NEEDS_ACTION when the provider reports no reply
Start of the event, an ISO-8601 instant. For an all-day event, midnight at the start of its date in the event’s time zone
Time-zone id the event is scheduled in, such as Europe/London, for display; the calendar’s own zone when the event names none or an unknown one
Event title; (no title) when the provider has none
Link to the event in the provider’s web UI; null when the provider gives none
The provider’s visibility setting for the event; DEFAULT when it sets none or a value not listed