GET/projects/{id}/time_entries.json

Retrieve all Time Entries for a Project

In ascending order by date, this retrieves time entries for all projects. A page contains 100 entries, but you can increase the page size to a maxium of 500 entries by using 'pageSize' parameter. To select a different page of data, set the 'page' query parameter to a value greater than zero. The total number of time entries in the project is in the X-Records HTTP header. X-Pages will be set to the total number of pages, and X-Page will be set to the current page.

Additional Notes:

The date field returned in the response is in UTC date/time The toDate, toTime, fromDate and fromTime are specified in your timezone.

Path Params

  • Name
    id
    Type
    string
    required
    Description

Query Params

  • Name
    page
    Type
    integer
    Description
    The page to start retrieving entries from ( e.g: page=1 gives records 1 - 500, page=2 gives records 501-1001 etc)
  • Name
    fromdate
    Type
    string
    Description
    string (YYYYMMDD) - The start date to retrieve from
  • Name
    fromtime
    Type
    string
    Description
    string (HH:MM) - The start time only if fromdate is passed
  • Name
    todate
    Type
    string
    Description
    string (YYYYMMDD) - The end date to retrieve to
  • Name
    totime
    Type
    string
    Description
    string (HH:MM) - The end time only if todate is passed
  • Name
    sortby
    Type
    string
    Description
    string - One of the following: date, user, task, tasklist, project, company, dateupdated (Default: date)
  • Name
    sortorder
    Type
    string
    Description
    ASC or DESC - The order to sort the returned data
  • Name
    userId
    Type
    integer
    Description
    Return time logs for a specific user only
  • Name
    billableType
    Type
    string
    Description
    string (billable or nonbillable).Filter the Time Entries to those that are Billable or Not Billable.
  • Name
    invoicedType
    Type
    string
    Description
    string (invoiced or noninvoiced) - filter the time entries to those that have been Invoiced or not.
  • Name
    projectType
    Type
    string
    Description
    string (all, active, archived) - Filter the time entries to those in Active projects, Archived projects or All projects.
  • Name
    showDeleted
    Type
    string
    Description
    string (true or false) - Filter time entries to include deleted time sheet entries or not
  • Name
    tagIds
    Type
    string
    Description
    numeric - Include one or more Tag IDs here to return only the time entries with those tags attached (eg &tagIds=23,445,454)
  • Name
    updatedAfterDate
    Type
    string
    Description
    string YYYYMMDDHHMMSS
  • Name
    pageSize
    Type
    string
    Description
    pageSize=500
  • Name
    taskTagIds
    Type
    string
    Description
    filter on task tags

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 Response

Examples

200 Response

application/json
{
  "time-entries": [
    {
      "project-id": "1",
      "isbillable": "0",
      "tasklistId": "",
      "todo-list-name": "",
      "todo-item-name": "",
      "isbilled": "0",
      "updated-date": "2017-11-13T13:08:23Z",
      "todo-list-id": "",
      "tags": [],
      "canEdit": false,
      "taskEstimatedTime": "0",
      "company-name": "MCG Cleaning Services",
      "id": "1",
      "invoiceNo": "",
      "person-last-name": "McGill",
      "parentTaskName": "",
      "dateUserPerspective": "2014-03-30T10:10:00Z",
      "minutes": "15",
      "person-first-name": "Holly",
      "description": "",
      "ticket-id": "",
      "createdAt": "2017-11-13T13:08:23Z",
      "taskIsPrivate": "0",
      "parentTaskId": "0",
      "company-id": "1",
      "project-status": "archived",
      "person-id": "1",
      "project-name": "Website rewrite!",
      "task-tags": [],
      "taskIsSubTask": "0",
      "todo-item-id": "",
      "date": "2014-03-30T09:10:00Z",
      "has-start-time": "1",
      "hours": "1"
    }
  ],
  "STATUS": "OK"
}