Sign in

v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB
Events

Get an event

Retrieves a specified event.

get/events/{eventId}

Path parameters

eventIdstring uuid required

Response

When request is successful. Returns an 'Event' object.

hrefstring nullable
relationstring nullable
methodstring nullable
idstring nullable

Unique identifier of the event.

eventType'Normal' | 'Pattern' | 'Occurrence' | 'ChangedOccurrence' | 'DeletedOccurrence'

The type of the event.

Possible values: Non Recurring Event = 0, Recurring Pattern Series = 1, Single Recurring Occurrence = 2, Modified Recurring Occurrence = 3, Deleted Recurring Occurrence = 4

type'Normal' | 'Pattern' | 'Occurrence' | 'ChangedOccurrence' | 'DeletedOccurrence'

The type of the event.

Possible values: Non Recurring Event = 0, Recurring Pattern Series = 1, Single Recurring Occurrence = 2, Modified Recurring Occurrence = 3, Deleted Recurring Occurrence = 4

subjectstring nullable

Subject of event.

descriptionstring nullable

Description of event.

locationstring nullable

Location of event.

allDayboolean

Whether or not the event is all day.

nonBillableboolean

Whether or not the event is billable. Note events with a duration greater than 12 hours automatically become non-billable.

startTimestring date-time

Start date and time of the event. Supported date format is ISO YYYY-MM-DDThh:mm:ss. Note: date and time will correlate with the time zone provided.

endTimestring date-time

End date and time of the event. Supported date format is ISO YYYY-MM-DDThh:mm:ss. Note: date and time will correlate with the time zone provided.

timeZonestring nullable

Time zone of the event for determining the start time and end time. Time zones will be in the IANA time zone format.

lastUpdatedstring date-time

The last date and time the event was updated. Supported date format is ISO YYYY-MM-DDThh:mm:ss.

additionalDataobject nullable

Any additional data provided for the event.

isDeletedboolean

Whether the event has been deleted.

Example response

{
  "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "subject": "Subject",
  "description": "Description",
  "location": "Location",
  "startTime": "2000-01-01T20:00:00",
  "endTime": "2000-01-01T20:00:00",
  "timeZone": "Australia/Sydney",
  "lastUpdated": "2000-01-01T20:00:00"
}