GET/projects/api/v3/timers.json

Get all running timers

Brings back all current running timers. Will return a set of existing intervals for each timer. If the timer has never been stopped then this interval will only have a from property set and the you will need to calculate the current duration of the timer.

Query Params

  • Name
    updatedAfterDate
    Type
    string
    Description

    filter by updated after date (deprecated, use updatedAfter)

  • Name
    updatedAfter
    Type
    string
    Description

    filter by updated after date

  • Name
    userId
    Type
    integer
    Description

    filter by user id

  • Name
    taskId
    Type
    integer
    Description

    filter by task id

  • Name
    projectId
    Type
    integer
    Description

    filter by project id

  • Name
    pageSize
    Type
    integer
    Description

    number of items in a page

    Default
    50
  • Name
    page
    Type
    integer
    Description

    page number

    Default
    1
  • Name
    skipCounts
    Type
    boolean
    Description

    SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.

  • Name
    showDeleted
    Type
    boolean
    Description

    include deleted items

    Default
    false
  • Name
    runningTimersOnly
    Type
    boolean
    Description

    enforce running timers only

    Default
    false
  • Name
    include
    Type
    array[string]
    Description

    include

    Format
    Comma separated values
    Allowed values
    • projects
    • projects.companies
    • tasks
    • tasks.parentTasks
    • tasks.tasklists
    • users
  • Name
    fields[users]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • firstName
    • lastName
    • title
    • email
    • companyId
    • company
    • isAdmin
    • isClientUser
    • isServiceAccount
    • type
    • deleted
    • avatarUrl
    • lengthOfDay
    • workingHoursId
    • workingHour
    • userRate
    • userCost
    • canAddProjects
  • Name
    fields[timers]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • userId
    • taskId
    • projectId
    • description
    • running
    • billable
    • deleted
    • dateCreated
    • dateDeleted
    • duration
    • lastStartedAt
    • serverTime
    • intervals
  • Name
    fields[tasks]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • dateUpdated
    • parentTaskId
    • isPrivate
    • status
    • tasklistId
    • startDate
    • dueDate
  • Name
    fields[tasklists]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • projectId
    • milestoneId
  • Name
    fields[projects]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    TimersResponse contains all the information returned when sending a GET request to the timers endpoint.
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    ErrorResponse defines how []Error should be marshaled to JSON.

Examples

200 OK

TimersResponse
{  "included": {    "companies": {      "additionalProp": {        "accounts": 0,        "addressOne": "string",        "addressTwo": "string",        "budgetDistribution": [          {            "color": "string",            "companyId": 0,            "count": 0,            "from": 0,            "to": 0          }        ],        "canSeePrivate": true,        "cid": "string",
Download Swagger