Calendar Events

Return a user count for items related to a user.

Options to query for events

NameUsageDefaultDescription
start_date"01/31/2016 00:00"-1 day from nowThe start date of events to return.
end_date"02/15/2016 00:00"+6 months from nowThe end date of events to return.
category_ids12,15,19-The event category id's.
user_ids1,2-The user id's of the user calendars you want to return.
team_ids45,78-The team id's of the team calendars you want to return.
calendar_ids23,14,78,89-The calendar id's of the calendars you want to return.
case_idc-123456-The events of a given case id.

Returning calendar event object

NameDescription
idThe unique id of the event.
subjectThe subject / name of the event.
summaryThe summary of the event.
user_idThe user id assigned to the event.
team_idThe team id assigned to the event.
calendar_idThe calendar id assigned to the event.
case_idThe case id assigned to the event.
category_idThe category id assigned to the event.
startThe UTC start date and time of the event.
start_unixThe UTC start date and time of the event as a UNIX time stamp.
starts_inThe readable time of when the event starts. i.e.
- in 1.2 hour(s) (if in the future)
- 25.3 day(s) ago (if in the past)
endThe UTC end date and time of the event.
end_unixThe UTC end date and time of the event as a UNIX time stamp.
is_pastReturn a Boolean of whether this event has already past or not.
durationThe duration of the event in minutes.
all_dayif this is this an all day event.
colorThe hex color of the event if assigned.
createdThe date this event was created.
created_unixThe date this event was created as a UNIX time stamp.
Language
Authorization