You must only install apps that call the Teamwork Graph API in test organizations. Apps calling the Teamwork Graph API require the read:graph:jiraor read:graph:confluence scope, which provides access to Teamwork Graph data across your entire organization. While apps still respect end-user permissions, this scope may grant access to sensitive information. For safety, only install these apps in organizations with test data. Do not install apps using this API in organizations with production data while this feature is in EAP.

Additionally, this EAP has significant limitations. To review the full list of limitations, see Limitations and considerations.

You must be part of this EAP in order to use the Teamwork Graph API. Express interest in joining through this form.

Represents a calendar event from an external scheduling or calendar system. Calendar events include meetings, appointments, or scheduled activities integrated from third-party calendar platforms.

Available fields and properties

The Teamwork Graph API has the following fields and properties that you can use in your queries:

Object type fields are the core data fields of the object. Use these when you want to retrieve specific information about the object in your queries.
Cypher query properties are metadata properties used for filtering and traversing relationships between different object types in Teamwork Graph. Use Cypher query properties when you need to filter or navigate relationships between this object and other objects in your queries.

Object type fields

Cypher query properties

Object type fields

You can access these fields in the GraphiQL playground using the book icon in the top left, and then searching for External calendar event.

Field	Type	Description
`allDayEvent`	`Boolean`	Indicates whether this is an all-day event (true) or has specific start and end times (false).
`attachments`	`[ExternalCalendarEventAttachment]`	List of attachments for ExternalCalendarEvent
`attendeeCount`	`Int`	Number of attendees invited to or participating in the calendar event.
`attendees`	`[ExternalAttendee]`	List of attendees for ExternalCalendarEvent
`completedAt`	`DateTime`	Timestamp when the calendar event ends.
`createdAt`	`DateTime`	Timestamp when the calendar event was created.
`creator`	`User`	User who created this calendar event.
`description`	`String`	Detailed description or agenda of the calendar event.
`displayName`	`String`	Display name or title of the calendar event as shown in the source system.
`eventType`	`ExternalEventType`	Type or category of the calendar event.
`exceedsMaxAttendees`	`Boolean`	Boolean that represents whether exceeds Max Attendees or not
`id`	`ID!`	Unique identifier for the calendar event. This ID is globally unique across the entire Teamwork Graph.
`lastEditor`	`User`	User who last updated this calendar event.
`lastUpdatedAt`	`DateTime`	Timestamp of the most recent update to the calendar event.
`locationAddress`	`String`	Address of the location
`locationCoordinates`	`String`	Coordinates of the location
`locationName`	`String`	Name of the location
`locationUrl`	`URL`	URL of the location
`provider`	`ExternalProvider`	Identifier of the external provider or integration that supplies this calendar event.
`recordingUrl`	`URL`	URL to access a recording of the event, if available.
`recurringEvent`	`Boolean`	Indicates whether this event repeats on a schedule (true) or is a one-time occurrence (false).
`startedAt`	`DateTime`	Timestamp when the calendar event starts.
`url`	`URL`	Direct URL to view or manage the calendar event in its source system.
`videoMeetingProvider`	`String`	Name of the video conferencing provider used for the event (e.g., "Zoom", "Microsoft Teams", "Google Meet").
`videoMeetingUrl`	`URL`	URL to join the video meeting associated with this calendar event.

Fields for ExternalCalendarEventAttachment

Field	Type	Description
`byteSize`	`Long`	Size of the attachment in bytes.
`mimeType`	`String`	MIME type of the attachment indicating its format.
`thumbnailUrl`	`URL`	URL to a thumbnail image of the attachment, if available.
`title`	`String`	Title or name of the attachment.
`url`	`URL`	Direct URL to access or download the attachment.

Fields for ExternalAttendee

Field	Type	Description
`isOptional`	`Boolean`	Indicates whether the attendee's participation is optional.
`rsvpStatus`	`ExternalAttendeeRsvpStatus`	RSVP response status of the attendee.
`user`	`User`	User object representing the attendee.

Values for ExternalAttendeeRsvpStatus

Value	Description
`ACCEPTED`	The attendee accepted
`DECLINED`	The attendee declined
`NOT_RESPONDED`	The attendee has not responded
`OTHER`	Other response status
`TENTATIVELY_ACCEPTED`	The attendee tentatively accepted

Fields for ExternalProvider

Field	Type	Description
`id`	`ID!`	Unique identifier for the external provider.
`logoUrl`	`URL`	URL to the provider's logo image for UI display.
`name`	`String`	Display name of the provider (e.g., "Google Drive", "Dropbox", "GitHub").

Values for ExternalEventType

Value	Description
`APPOINTMENT`	The event is an appointment
`BIRTHDAY`	The event is a birthday
`DEFAULT`	The event is a default event
`EVENT`	The event is an event
`FOCUS_TIME`	The event is focus time
`OUT_OF_OFFICE`	The event is out of office
`REMINDER`	The event is a reminder
`TASK`	The event is a task
`WORKING_LOCATION`	The event is a working location

Available relationships

The following relationships are currently supported for External calendar event:

From relationships

Relationships where External calendar event is the source object.

Relationship name	From object type	To object type
External calendar has linked external document	External calendar event	External document