GET/projects/api/v3/time.json

Get all time entries

Return all logged time entries for all projects. Only the time entries that the logged-in user can access will be returned.

Query Params

  • Name
    updatedAfter
    Type
    string
    Description

    filter by updated after date

  • Name
    startDate
    Type
    string
    Description

    filter by a starting date

  • Name
    reportFormat
    Type
    string
    Description

    define the format of the report

  • Name
    projectStatus
    Type
    string
    Description

    filter by project status

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

    order mode

    Default
    asc
    Allowed values
    • asc
    • desc
  • Name
    orderBy
    Type
    string
    Description

    sort order

    Default
    date
    Allowed values
    • company
    • date
    • dateupdated
    • project
    • task
    • tasklist
    • user
    • description
    • billed
    • billable
    • timespent
  • 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
    updatedBy
    Type
    integer
    Description

    filter by the user who updated the timelog

  • Name
    ticketId
    Type
    integer
    Description

    filter by ticket id

  • 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 (deprecated, use projectIds)

  • Name
    pageSize
    Type
    integer
    Description

    number of items in a page

    Default
    50
  • Name
    page
    Type
    integer
    Description

    page number

    Default
    1
  • Name
    invoiceId
    Type
    integer
    Description

    filter by invoice id

  • Name
    budgetId
    Type
    integer
    Description

    filter by budget id

  • Name
    allocationId
    Type
    integer
    Description

    filter by allocation id

  • Name
    useFallbackMethod
    Type
    boolean
    Description

    use fallback method, where timelogs on deleted tasks and tasklist will fall back to the parent project.

  • Name
    unattachedTimelogs
    Type
    boolean
    Description

    filter by timelogs that are directly logged against projects and not its child tasks

  • 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
    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
    matchAllTaskTags
    Type
    boolean
    Description

    match all task tags

  • Name
    matchAllTags
    Type
    boolean
    Description

    match all tags

  • Name
    matchAllProjectTags
    Type
    boolean
    Description

    match all project tags

  • Name
    isReportDownload
    Type
    boolean
    Description

    generate a report document

  • Name
    includeTotals
    Type
    boolean
    Description

    include totals

    Default
    false
  • Name
    includePermissions
    Type
    boolean
    Description

    include permissions

    Default
    false
  • Name
    includeDescendants
    Type
    boolean
    Description

    include descendants

    Default
    false
  • Name
    includeArchivedProjects
    Type
    boolean
    Description

    include archived projects

    Default
    false
  • Name
    taskTagIds
    Type
    array[integer]
    Description

    filter by task tag ids

    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 tag ids

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

    customise the report by selecting columns

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

    filter by project company ids (deprecated, use projectCompanyIds)

    Format
    Comma separated values
  • 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
    include
    Type
    array[string]
    Description

    include

    Format
    Comma separated values
    Allowed values
    • projects
    • projects.companies
    • projects.categories
    • projects.permissions
    • tags
    • tasks
    • tasks.parentTasks
    • tasks.tasklists
    • tasks.users
    • users
    • project.billing
    • project.billing.currencies
  • Name
    ids
    Type
    array[integer]
    Description

    filter by ids

    Format
    Comma separated values
  • 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[timelogs]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • dateCreated
    • minutes
    • description
    • timeLogged
    • billable
    • deleted
    • dateDeleted
    • hasStartTime
    • dateEdited
    • deskTicketId
    • userId
    • taskId
    • projectId
    • loggedByUserId
    • deletedByUserId
    • editedByUserId
    • taskIdPreMove
    • projectBillingInvoiceId
  • 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[tags]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • color
    • count
  • Name
    fields[projects]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
  • Name
    fields[projectcategories]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • color
    • count
    • parent
    • parentId
  • Name
    fields[companies]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • logoUploadedToServer
    • logoImage
  • 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
    TimelogsResponse contains information about a group of timelogs.
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    ErrorResponse defines how []Error should be marshaled to JSON.

Examples

200 OK

TimelogsResponse
{  "included": {    "billingInvoices": {      "additionalProp": {        "PONumber": "string",        "companyId": 0,        "companyName": "string",        "createdByUserFirstName": "string",        "createdByUserId": 0,        "createdByUserLastName": "string",        "currency": {          "id": 0,          "meta": {},          "type": "string"        },        "currencyCode": "string",        "dateCreated": "string",        "dateUpdated": "string",
Download Swagger