data
calendars

Retrieve a collection of user's calendar events

Returns calendar events for a user.

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

Path parameters

fulcra_useridstring uuid required

Query parameters

start_timestring date-time required

The starting timestamp in ISO 8601 format (inclusive)

Example:2023-02-01 00:00:00Z
end_timestring date-time required

The ending timestamp in ISO 8601 format (exclusive)

Example:2023-02-03 00:00:00Z
calendar_idsstring[] nullable

A list of IDs of calendars to search. Only results from these calendars will be returned.

Response

Successful Response

allow_new_time_proposalsboolean nullable required

True if attendees may propose a new time when responding

availabilitystring nullable required

A string that indicates the event's availability status the calendar.

calendar_event_idstring uuid required

Calendar Event ID

calendar_idstring uuid required

Calendar ID

calendar_item_external_identifierstring nullable required

The external identifier for this calendar event, as provided by an external calendar server.

calendar_item_identifierstring nullable required

The identifier for this calendar item, as sent by the device. May be different from event_identifier.

creation_datestring date-time nullable required

The date when this event was created.

end_datestring date-time required

the date/time when this event ends.

event_identifierstring nullable required

The identifier for this event, as sent by the device. May be different from calendar_item_identifier.

extrasobject nullable required

Extra values that are not (yet) accounted for in the schema.

has_alarmsboolean nullable required

True if the device indicates that the event has alarms.

has_attendeesboolean nullable required

True if the device indicates that the event has attendees.

has_notesboolean nullable required

True if the device indicates that the event has notes.

has_recurrence_rulesboolean nullable required

True if the device indicates that the event recurs.

is_all_dayboolean nullable required

True if the event is all day.

is_detachedboolean nullable required

True if the event is 'detached' from a recurring event.

last_modified_datestring date-time nullable required

The date/time when this event was last modified.

locationstring nullable required

The string description of the location of the event.

notesstring nullable required

The notes associated with the event.

occurrence_datestring date-time nullable required

The date of this specific instance of a recurring event.

start_datestring date-time required

the date/time when this event starts.

statusstring nullable required

The device-platform-specific text that describes the status (e.g. 'cancelled', 'confirmed') of an event

time_zonestring nullable required

The text describing the time zone of the event.

titlestring nullable required

The title of the event.

urlstring nullable required

The URL of the calendar item associated with this event.

Changes

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