Back to TeamworkGet 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.
Input
type: object
properties:
parameters:
type: object
properties:
updatedAfter:
type: string
format: date-time
description: filter by updated after date
startDate:
type: string
format: date-time
description: filter by a starting date
reportFormat:
type: string
description: define the format of the report
projectStatus:
type: string
enum:
- active
- current
- late
- upcoming
- completed
- deleted
description: filter by project status
orderMode:
type: string
enum:
- asc
- desc
default: asc
description: order mode
orderBy:
type: string
enum:
- company
- date
- dateupdated
- project
- task
- tasklist
- user
- description
- billed
- billable
- timespent
default: date
description: sort order
invoicedType:
type: string
enum:
- all
- invoiced
- noninvoiced
default: all
description: filter by invoiced type
endDate:
type: string
format: date-time
description: filter by an ending date
billableType:
type: string
enum:
- all
- billable
- non-billable
default: all
description: filter by billable type
ticketId:
type: integer
description: filter by ticket id
tasklistId:
type: integer
description: filter by tasklist id
taskId:
type: integer
description: filter by task id (deprecated, use taskIds)
projectId:
type: integer
description: filter by project id (deprecated, use projectIds)
pageSize:
type: integer
default: '50'
description: number of items in a page
page:
type: integer
default: '1'
description: page number
budgetId:
type: integer
description: filter by budget id
allocationId:
type: integer
description: filter by allocation id
unattachedTimelogs:
type: boolean
description: >-
filter by timelogs that are directly logged against projects and not
its child tasks
showDeleted:
type: boolean
default: 'false'
description: include deleted items
onlyStarredProjects:
type: boolean
description: filter by starred projects only
matchAllTaskTags:
type: boolean
description: match all task tags
matchAllTags:
type: boolean
description: match all tags
matchAllProjectTags:
type: boolean
description: match all project tags
isReportDownload:
type: boolean
description: generate a report document
includeTotals:
type: boolean
default: 'false'
description: include totals
includePermissions:
type: boolean
default: 'false'
description: include permissions
includeDescendants:
type: boolean
default: 'false'
description: include descendants
includeArchivedProjects:
type: boolean
default: 'false'
description: include archived projects
taskTagIds:
type: array
items:
type: integer
description: filter by task tag ids
taskIds:
type: array
items:
type: integer
description: filter by task ids
tagIds:
type: array
items:
type: integer
description: filter by tag ids
selectedColumns:
type: array
items:
type: string
description: customise the report by selecting columns
projectsFromCompanyId:
type: array
items:
type: integer
description: filter by project company ids (deprecated, use projectCompanyIds)
projectTagIds:
type: array
items:
type: integer
description: filter by project tag ids
projectStatuses:
type: array
items:
enum:
- active
- current
- late
- upcoming
- completed
- deleted
type: string
description: filter by project statuses
projectOwnerIds:
type: array
items:
type: integer
description: filter by project owner ids
projectIds:
type: array
items:
type: integer
description: filter by project ids
projectHealths:
type: array
items:
enum:
- '0'
- '1'
- '2'
- '3'
type: integer
description: |-
filter by project healths
0: not set
1: bad
2: ok
3: good
projectCompanyIds:
type: array
items:
type: integer
description: filter by project company ids
projectCategoryIds:
type: array
items:
type: integer
description: filter by project category ids
include:
type: array
items:
enum:
- projects
- projects.companies
- projects.categories
- tags
- tasks
- tasks.parentTasks
- tasks.tasklists
- users
type: string
description: include
ids:
type: array
items:
type: integer
description: filter by ids
fields[users]:
type: array
items:
enum:
- id
- firstName
- lastName
- title
- email
- companyId
- company
- isAdmin
- isClientUser
- isServiceAccount
- type
- deleted
- avatarUrl
- lengthOfDay
- workingHoursId
- workingHour
- userRate
- userCost
- canAddProjects
type: string
fields[timelogs]:
type: array
items:
enum:
- id
- dateCreated
- minutes
- description
- timeLogged
- billable
- deleted
- dateDeleted
- hasStartTime
- dateEdited
- deskTicketId
- userId
- taskId
- projectId
- loggedByUserId
- deletedByUserId
- editedByUserId
- taskIdPreMove
- projectBillingInvoiceId
type: string
fields[tasks]:
type: array
items:
enum:
- id
- name
- dateUpdated
- parentTaskId
- isPrivate
- status
- tasklistId
- startDate
- dueDate
type: string
fields[tasklists]:
type: array
items:
enum:
- id
- name
- projectId
- milestoneId
type: string
fields[tags]:
type: array
items:
enum:
- id
- name
- color
- count
type: string
fields[projects]:
type: array
items:
enum:
- id
- name
type: string
fields[projectcategories]:
type: array
items:
enum:
- id
- name
- color
- count
- parent
- parentId
type: string
fields[companies]:
type: array
items:
enum:
- id
- name
- logoUploadedToServer
- logoImage
type: string
assignedToUserIds:
type: array
items:
type: integer
description: filter by assigned user ids
assignedToTeamIds:
type: array
items:
type: integer
description: filter by assigned team ids
assignedToCompanyIds:
type: array
items:
type: integer
description: filter by assigned company ids
assignedTeamIds:
type: array
items:
type: integer
description: filter by assigned team ids
title: Parameters
Output
type: object
title: TimelogsResponse
properties:
included:
type: object
properties:
companies:
type: object
projects:
type: object
tags:
type: object
tasklists:
type: object
tasks:
type: object
userRates:
type: object
users:
type: object
meta:
type: object
title: Meta
properties:
averageSpend:
type: integer
limit:
type: integer
nextCursor:
type: string
page:
type: object
title: MetaPage
properties:
count:
type: integer
hasMore:
type: boolean
pageOffset:
type: integer
pageSize:
type: integer
prevCursor:
type: string
totalCapacity:
type: integer
timelogs:
type: array
items:
type: object
title: Timelog
properties:
assignedTeamIds:
type: array
items:
type: integer
billable:
type: boolean
createdAt:
type: string
dateCreated:
type: string
dateDeleted:
type: string
dateEdited:
type: string
deleted:
type: boolean
deletedAt:
type: string
deletedBy:
type: integer
deletedByUserId:
type: integer
description:
type: string
deskTicketId:
type: integer
editedByUserId:
type: integer
hasStartTime:
type: boolean
id:
type: integer
isBillable:
type: boolean
loggedBy:
type: integer
loggedByUserId:
type: integer
minutes:
type: integer
project:
type: object
title: Relationship
properties:
id:
type: integer
meta:
type: object
type:
type: string
projectBillingInvoice:
type: object
title: Relationship
properties:
id:
type: integer
meta:
type: object
type:
type: string
projectBillingInvoiceId:
type: integer
projectId:
type: integer
tagIds:
type: array
items:
type: integer
tags:
type: array
items:
type: object
title: Relationship
properties:
id:
type: integer
meta:
type: object
type:
type: string
task:
type: object
title: Relationship
properties:
id:
type: integer
meta:
type: object
type:
type: string
taskId:
type: integer
taskIdPreMove:
type: integer
taskPreMove:
type: object
title: Relationship
properties:
id:
type: integer
meta:
type: object
type:
type: string
timeLogged:
type: string
updatedAt:
type: string
updatedBy:
type: integer
user:
type: object
title: Relationship
properties:
id:
type: integer
meta:
type: object
type:
type: string
userId:
type: integer