API Reference - Events

Events within Trackops are not required to be connected to a case or a subject.

Listing Events

Returns a collection of event records, optionally filtered by the available request parameters.

GET /api/v1/events

 

Available Request Parameters:

Name Type Required Description
id integer no ID of the event.
title string no Title/name of the event.
calendar integer no ID of the calendar the event is assigned to.
case integer no ID of the case connected to this event.
subject integer no ID of the subject associated with this event.
is_allday boolean no When true, only include "all day" events.
start_from timestamp no Event starts on or after the date (Alias: From).
start_to timestamp no Event starts on or before the date (Alias: To).
end_from timestamp no Event ends on or after the date.
end_to timestamp no Event ends on or before the date.
alert_from timestamp no Event alert is scheduled on or after the date.
alert_to timestamp no Event alert is scheduled on or before the date.
alert_sent_from timestamp no Event alert was delivered on or after the date.
alert_sent_to timestamp no Event alert was delivered on or before the date.
created_from timestamp no Created on or after the date, as determined by the system.
created_to timestamp no Created on or before the date, as determined by the system.
updated_from timestamp no Updated on or after the date, as determined by the system.
updated_to timestamp no Updated on or before the date, as determined by the system.

Note: All timestamp parameters are queried and returned in UTC.

Getting an Event

Returns a single event record, based on the numeric ID.

GET /api/v1/events/{event_id}

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request