GET/projects/api/v3/timesheets.json

Get list of timesheet rows

Return a list of timesheet rows for the given user depending on param options.

Query Params

  • Name
    weekDate
    Type
    string
    Description
  • Name
    taskStatus
    Type
    string
    Description

    filter by task status

    Default
    all
    Allowed values
    • all
    • completed
    • incomplete
  • Name
    startDate
    Type
    string
    Description

    filter by a starting date, will default to the start of users work week.

  • Name
    searchTerm
    Type
    string
    Description

    filter by tasks/projects/company names

  • Name
    reportFormat
    Type
    string
    Description

    define the format of the report

    Allowed values
    • pdf
    • xlsx
    • csv
    • html
  • Name
    orderMode
    Type
    string
    Description

    order mode

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

    order by

    Default
    dueDate
    Allowed values
    • project
    • company
    • duedate
    • timelogrecency
  • 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, will default to the end of users work week.

  • Name
    billableType
    Type
    string
    Description

    filter by billable type

    Default
    all
    Allowed values
    • all
    • billable
    • nonbillable
  • Name
    userId
    Type
    integer
    Description

    filter by user id, will default to session user

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

    filter by starred projects

  • Name
    isReportDownload
    Type
    boolean
    Description

    generate a report export.

    Default
    false
  • Name
    includeUnavailableTimes
    Type
    boolean
    Description

    include users unavailable times field.

  • Name
    includeBreakdown
    Type
    boolean
    Description

    includes a breakdown of the totals

  • Name
    hasTimeLogged
    Type
    boolean
    Description

    filter by tasks and projects that have time logged

  • Name
    assignedToTeams
    Type
    boolean
    Description

    also include tasks that are assigned to teams

  • Name
    assignedToMe
    Type
    boolean
    Description

    also include tasks that are assigned to me

  • 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
    projectStatuses
    Type
    array[string]
    Description

    filter by project statuses

    Default
    all
    Format
    Comma separated values
    Allowed values
    • all
    • active
    • inactive
    • current
    • late
    • upcoming
    • completed
    • deleted
  • Name
    projectIds
    Type
    array[integer]
    Description

    filter by project ids

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

    filter by project category ids

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

    include

    Format
    Comma separated values
    Allowed values
    • users
    • timelogs
    • tasks
    • tasks.tasklist
    • tasks.users
    • tasks.parentTasks
    • projects
    • projects.permissions
    • timesheetsCustomRows
    • unavailableTimes
    • calendarEventTypes
  • Name
    excludeTimeframes
    Type
    array[string]
    Description

    exclude by time frames

    Default
    empty
    Format
    Comma separated values
    Allowed values
    • due-this-week
    • starting-this-week
    • no-due-date
    • no-start-date
    • created-this-week
    • completed-this-week
  • Name
    companyIds
    Type
    array[integer]
    Description

    filter by company ids

    Format
    Comma separated values

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    MyTimesheetsResponse contains timesheets list, includes and metadata.
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    ErrorResponse defines how []Error should be marshaled to JSON.

Examples

200 OK

MyTimesheetsResponse
{  "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