Back to TeamworkGet list of timesheet rows
Return a list of timesheet rows for the given user depending on param options.
Input
type: object
properties:
parameters:
type: object
properties:
taskStatus:
type: string
enum:
- all
- completed
- incomplete
default: all
description: filter by task status
startDate:
type: string
format: date
description: >-
filter by a starting date, will default to the start of users work
week.
searchTerm:
type: string
description: filter by tasks/projects/company names
reportFormat:
type: string
enum:
- pdf
- xlsx
- csv
- html
description: define the format of the report
invoicedType:
type: string
enum:
- all
- invoiced
- noninvoiced
default: all
description: filter by invoiced type
endDate:
type: string
format: date
description: filter by an ending date, will default to the end of users work week.
billableType:
type: string
enum:
- all
- billable
- nonbillable
default: all
description: filter by billable type
userId:
type: integer
description: filter by user id, will default to session user
pageSize:
type: integer
default: '50'
description: number of items in a page
page:
type: integer
default: '1'
description: page number
skipCounts:
type: boolean
description: |-
SkipCounts allows you to skip doing counts on a list API endpoint for
performance reasons.
onlyStarredProjects:
type: boolean
description: filter by starred projects
isReportDownload:
type: boolean
default: 'false'
description: generate a report export.
hasTimeLogged:
type: boolean
description: filter by tasks and projects that have time logged
taskIds:
type: array
items:
type: integer
description: filter by task ids
tagIds:
type: array
items:
type: integer
description: filter by tag ids
projectStatuses:
type: array
items:
enum:
- all
- active
- inactive
- current
- late
- upcoming
- completed
- deleted
type: string
default: all
description: filter by project statuses
projectIds:
type: array
items:
type: integer
description: filter by project ids
include:
type: array
items:
enum:
- users
- timelogs
- tasks
- tasks.tasklist
- tasks.users
- projects
- projects.permissions
- timesheetsCustomRows
type: string
description: include
excludeTimeframes:
type: array
items:
enum:
- due-this-week
- starting-this-week
- no-due-date
- no-start-date
- created-this-week
- completed-this-week
type: string
default: empty
description: exclude by time frames
companyIds:
type: array
items:
type: integer
description: filter by company ids
title: Parameters
Output
type: object
title: MyTimesheetsResponse
properties:
included:
type: object
properties:
companies:
type: object
projectPermissions:
type: object
projects:
type: object
subtaskStats:
type: object
tasklists:
type: object
tasks:
type: object
timesheetCustomRows:
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
timesheets:
type: array
items:
type: object
title: MyTimesheet
properties:
customRow:
type: object
title: Relationship
properties:
id:
type: integer
meta:
type: object
type:
type: string
dates:
type: object
entity:
type: object
title: Relationship
properties:
id:
type: integer
meta:
type: object
type:
type: string
isCustomRow:
type: boolean
total:
type: integer