--- title: "Retrieve a collection of user's calendar events" method: GET path: "/data/v0/{fulcra_userid}/calendar_events" tags: ["data", "calendars"] --- # Retrieve a collection of user's calendar events `GET /data/v0/{fulcra_userid}/calendar_events` ## Request - Base URL: `https://api.fulcradynamics.com` - URL: `https://api.fulcradynamics.com/data/v0/{fulcra_userid}/calendar_events` - Auth: HTTP bearer Returns calendar events for a user. ## Path parameters - `fulcra_userid` string, uuid, required ## Query parameters - `start_time` string, date-time, required: The starting timestamp in ISO 8601 format (inclusive) - `end_time` string, date-time, required: The ending timestamp in ISO 8601 format (exclusive) - `calendar_ids` string[], nullable: A list of IDs of calendars to search. Only results from these calendars will be returned. ## Response `200` Successful Response - FulcraCalendarEvent[] - `allow_new_time_proposals` boolean, nullable, required: True if attendees may propose a new time when responding - `availability` string, nullable, required: A string that indicates the event's availability status the calendar. - `calendar_event_id` string, uuid, required: Calendar Event ID - `calendar_id` string, uuid, required: Calendar ID - `calendar_item_external_identifier` string, nullable, required: The external identifier for this calendar event, as provided by an external calendar server. - `calendar_item_identifier` string, nullable, required: The identifier for this calendar item, as sent by the device. May be different from event_identifier. - `creation_date` string, date-time, nullable, required: The date when this event was created. - `end_date` string, date-time, required: the date/time when this event ends. - `event_identifier` string, nullable, required: The identifier for this event, as sent by the device. May be different from calendar_item_identifier. - `extras` object, nullable, required: Extra values that are not (yet) accounted for in the schema. - `geolocation` GeofenceLocation, required: Represents a geofence: in other words, a specific location in the real world with a defined area and boundary. These are often used to define rules for triggering events and/or notifications. - `altitude` number, nullable, required: The altitude above sea level associated with the area (m) - `ellipsoidal_altitude` number, nullable, required: The altitude as height above the WGS 84 ellipsoid (m) - `floor` integer, nullable, required: The floor of the building.Note: Reference points (e.g. 'first floor' may differ by locale. - `horizontal_accuracy` number, nullable, required: The horizontal accuracy for the location (m) - `is_produced_by_accessory` boolean, nullable, required: True if the device that gathered this location received the value from an external accessory. - `is_simulated_by_software` boolean, nullable, required: True if the device indicates that the location was simulated by software. - `latitude` number, required: The latitude of the center of the area (deg) - `location_timestamp` string, date-time, nullable, required: The time at which this location was calculated. - `longitude` number, required: The longitude of the center of the area (deg) - `radius` number, nullable, required: The radius of the location area (m) - `title` string, nullable, required: The geofence location's title. - `vertical_accuracy` number, nullable, required: The vertical accuracy for the location (m) - `has_alarms` boolean, nullable, required: True if the device indicates that the event has alarms. - `has_attendees` boolean, nullable, required: True if the device indicates that the event has attendees. - `has_notes` boolean, nullable, required: True if the device indicates that the event has notes. - `has_recurrence_rules` boolean, nullable, required: True if the device indicates that the event recurs. - `is_all_day` boolean, nullable, required: True if the event is all day. - `is_detached` boolean, nullable, required: True if the event is 'detached' from a recurring event. - `last_modified_date` string, date-time, nullable, required: The date/time when this event was last modified. - `location` string, nullable, required: The string description of the location of the event. - `notes` string, nullable, required: The notes associated with the event. - `occurrence_date` string, date-time, nullable, required: The date of this specific instance of a recurring event. - `organizer` union, required: The organizer of the event. - string, uuid - FulcraCalendarEventParticipant: Represents an entity -- person, room, building, group, chatbot, etc. -- that is invited to a calendar event. - `contact_id` string, uuid, nullable, required: If this participant is known as a contact for this Fulcra user, this is the ID. - `is_current_user` boolean, nullable, required: True if the participant is the user of the device that sent the information about the event. - `name` string, nullable, required: The name of the participant. - `participant_role` string, nullable, required: Describes the participant's role in the event. - `participant_status` string, nullable, required: Describes the participation status (e.g. 'attending') of the participant. - `participant_type` string, nullable, required: Describes the type of participant (e.g. 'person', 'room'). - `url` string, nullable, required: A URL identifying this participant. - `participants` union, required: The participants of the event. - FulcraCalendarEventParticipant[] - `contact_id` string, uuid, nullable, required: If this participant is known as a contact for this Fulcra user, this is the ID. - `is_current_user` boolean, nullable, required: True if the participant is the user of the device that sent the information about the event. - `name` string, nullable, required: The name of the participant. - `participant_role` string, nullable, required: Describes the participant's role in the event. - `participant_status` string, nullable, required: Describes the participation status (e.g. 'attending') of the participant. - `participant_type` string, nullable, required: Describes the type of participant (e.g. 'person', 'room'). - `url` string, nullable, required: A URL identifying this participant. - string[] - `recurrence_rules` FulcraCalendarRecurrenceRule[], nullable, required: The rules that describe the cadence of a recurring event. - `calendar_id` string, uuid, nullable, required: Calendar ID - `days_of_the_month` unknown[], nullable, required: A list of the days of the month on which this event occurs. - unknown - `days_of_the_week` unknown[], nullable, required: A list of the days of the week on which this event occurs. - unknown - `days_of_the_year` unknown[], nullable, required: A list of the days of the year on which this event occurs. - unknown - `first_day_of_the_week` integer, nullable, required: A value indicating which day of the week is considered to be the beginning of the week. 1 is Sunday, 7 is Saturday. - `frequency` string, nullable, required: The description of the frequency for a recurring event (e.g. 'weekly') - `interval` integer, nullable, required: Using the value of `frequency` as the unit, the number of units that occur between events. - `months_of_the_year` unknown[], nullable, required: A list of the months of the year on which this event occurs. - unknown - `recurrence_rule_id` string, uuid, required: Recurrence rule ID - `set_positions` unknown[], nullable, required: A list of numbers that indicate which recurrences are included in this rule's frequency. - unknown - `weeks_of_the_year` unknown[], nullable, required: A list of the weeks of the year on which this event occurs. - unknown - `start_date` string, date-time, required: the date/time when this event starts. - `status` string, nullable, required: The device-platform-specific text that describes the status (e.g. 'cancelled', 'confirmed') of an event - `time_zone` string, nullable, required: The text describing the time zone of the event. - `title` string, nullable, required: The title of the event. - `url` string, nullable, required: The URL of the calendar item associated with this event. ## Other responses - `422`: Validation Error --- [API](https://skmtc.dev/fulcradynamics/apis/fulcra-life-api.md) · [All operations](https://skmtc.dev/fulcradynamics/apis/fulcra-life-api/llms.txt) · [OpenAPI document](https://skmtc.dev/fulcradynamics/apis/fulcra-life-api/revisions/d85136fc304a?raw)