GET/projects/api/v3/time/total.json

Get timelog totals.

Query Params

  • Name
    updatedAfter
    Type
    string
    Description

    filter by updated after

  • Name
    startDate
    Type
    string
    Description

    filter by a starting date

  • Name
    projectStatus
    Type
    string
    Description

    filter by project status

    Allowed values
    • active
    • current
    • late
    • upcoming
    • completed
    • deleted
  • Name
    invoicedType
    Type
    string
    Description

    filter by invoiced type

    Default
    all
    Allowed values
    • all
    • invoiced
    • noninvoiced
  • Name
    endDate
    Type
    string
    Description

    filter by an ending date

  • Name
    billableType
    Type
    string
    Description

    filter by billable type

    Default
    all
    Allowed values
    • all
    • billable
    • non-billable
  • Name
    userId
    Type
    integer
    Description

    filter by user id (deprecated, use assignedToUserIds)

  • Name
    tasklistId
    Type
    integer
    Description

    filter by tasklist id

  • Name
    taskId
    Type
    integer
    Description

    filter by task id (deprecated, use taskIds)

  • Name
    projectId
    Type
    integer
    Description

    filter by project id

  • Name
    deskTicketId
    Type
    integer
    Description

    filter by desk ticket id

  • Name
    returnCostInfo
    Type
    boolean
    Description

    used to return the cost rate and total

  • Name
    returnBillableInfo
    Type
    boolean
    Description

    used to return the billable rate and total

  • Name
    onlyStarredProjects
    Type
    boolean
    Description

    filter by starred projects only

  • Name
    matchAllProjectTags
    Type
    boolean
    Description

    match all project tags

  • Name
    includeDescendants
    Type
    boolean
    Description

    get subtask totals

  • Name
    includeArchivedProjects
    Type
    boolean
    Description

    include archived projects

    Default
    false
  • Name
    userIds
    Type
    array[integer]
    Description

    filter by user ids (deprecated, use assignedToUserIds)

    Format
    Comma separated values
  • Name
    taskStatuses
    Type
    array[string]
    Description

    filter by task statuses

    Format
    Comma separated values
  • Name
    taskIds
    Type
    array[integer]
    Description

    filter by task ids

    Format
    Comma separated values
  • Name
    tagIds
    Type
    array[integer]
    Description

    filter by timelog tag ids

    Format
    Comma separated values
  • Name
    subTaskStatuses
    Type
    array[string]
    Description

    filter by sub-task status, includeDescendants must be set to true for this to have any effect

    Default
    all
    Format
    Comma separated values
    Allowed values
    • all
    • completed
    • incomplete
  • Name
    projectTagIds
    Type
    array[integer]
    Description

    filter by project tag ids

    Format
    Comma separated values
  • Name
    projectStatuses
    Type
    array[string]
    Description

    filter by project statuses

    Format
    Comma separated values
    Allowed values
    • active
    • current
    • late
    • upcoming
    • completed
    • deleted
  • Name
    projectOwnerIds
    Type
    array[integer]
    Description

    filter by project owner ids

    Format
    Comma separated values
  • Name
    projectIds
    Type
    array[integer]
    Description

    filter by project ids

    Format
    Comma separated values
  • Name
    projectHealths
    Type
    array[integer]
    Description

    filter by project healths

    0: not set 1: bad 2: ok 3: good

    Format
    Comma separated values
    Allowed values
    • 0
    • 1
    • 2
    • 3
  • Name
    projectCompanyIds
    Type
    array[integer]
    Description

    filter by project company ids

    Format
    Comma separated values
  • Name
    projectCategoryIds
    Type
    array[integer]
    Description

    filter by project category ids set to 0 to filter by projects without a category

    Format
    Comma separated values
  • Name
    companyIds
    Type
    array[integer]
    Description

    filter by company ids

    Format
    Comma separated values
  • Name
    assignedToUserIds
    Type
    array[integer]
    Description

    filter by assigned user ids

    Format
    Comma separated values
  • Name
    assignedToTeamIds
    Type
    array[integer]
    Description

    filter by assigned team ids

    Format
    Comma separated values
  • Name
    assignedToCompanyIds
    Type
    array[integer]
    Description

    filter by assigned company ids

    Format
    Comma separated values
  • Name
    assignedTeamIds
    Type
    array[integer]
    Description

    filter by assigned team ids

    Format
    Comma separated values

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    TotalsResponse contains information about timelog totals.
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    ErrorResponse defines how []Error should be marshaled to JSON.

Examples

200 OK

TotalsResponse
{
  "financialTotals": {
    "totalCost": 0,
    "totalCostBillable": 0,
    "totalCostBilled": 0
  },
  "subTasks": {
    "estimatedMinutes": 0,
    "minutes": 0,
    "minutesBillable": 0
  },
  "time-totals": {
    "estimatedMinutes": 0,
    "estimatedMinutesActive": 0,
    "estimatedMinutesCompleted": 0,
    "estimatedMinutesFiltered": 0,
    "estimatedMinutesWithLoggedTime": 0,
    "minutes": 0,
    "minutesBillable": 0,
    "minutesBilled": 0,
    "minutesNonBillable": 0,
    "minutesNonBilled": 0
  }
}
Download Swagger