Get Timer

UNDER DEVELOPMENT

Service Application Warning

Timer endpoints all operate from the current user and because of this are not available to service applications. If this restriction impacts your business model, please contact support and we will consider opening certain timer access up to service applications by requiring a staff id.

Service applications can list all the timers in the deployment. Installed and web application types can only list the current user's timers.

Returns a timer identified by its id.

GET /timers/:id

Handling the response

Below is a table of available response fields and objects that are returned within the response object of the returned object. The optional fields and objects can be requested in the _fields parameter. Underlined values are always returned.

id	Integer	A unique id assigned to the timer. This ID can be used to manage the timer.
seconds	Integer	The amount of seconds recored against the timer.
subject	String	The textual subject assigned to the timer on creation.
status	String	"running" if the timer is running, otherwise "stopped"
against_type	String	Name of the object the timer is against, if any. For example, issue or job.
against_id	Integer	Unique id of the object the timer is against.
against_title	String	The title of the against object if the object exists.
staff	Object	The staff object against the timer.
breadcrumbs	Array	Returns breadcrumbs for the timer

For example, to get timer #10 with against type included in the response:

GET /timers/10.xml?_fields=against_type