TrackingTime API

Projects

This section describes how to access your account's project data.

Parameters

Type Parameter Description Required
Integer id Read only
String name A human readable identifier. YES
String notes Max. 5,000 chars. NO
Integer service_id Ths id of a project's service type NO
Integer customer_id The id of the project's customer NO
Boolean is_archived Indicates whether the project is archived or not. Default: false NO
Boolean following Indicates whether the user is following this project. Default: false NO
Date delivery_date The date when the project hast to be delivered. NO
Double estimated_time Time estimate expressed in hours NO
Double is_billable Indicates whether this project is billable NO
Double hourly_rate The default hourly rate for tasks on this project NO
Double hourly_cost The default hourly cost for tasks on this project NO
Double fixed_rate A fixed amount charged for this project NO
Boolean is_template Specifies whether this project can be duplicated as a template or not. NO
Date start_date The date, on which the first work event was tracked Read only
Date end_date The date, on which the last work event is tracked. This is calculated when the project is archived by the user Read only
Double accumulated_time The total amount of time worked in this project, expressed in seconds Read only
String worked_hours The total amount of time worked in this project, expressed in hours Read only
String worked_hours_today Number of hours worked today for this project Read only
String worked_hours_this_week Number of hours worked this week for this project Read only
String worked_hours_this_month Number of hours worked this month for this project Read only
String active_tasks Number of currently active tasks Read only
String archived_tasks Number of currently closed tasks Read only
Double billable_hours The number of hours worked on billable project tasks Read only
Double non_billable_hours The number of hours worked on non-billable project tasks Read only
JSON json Store user preferences in JSON format No
String color Set the project's color: [GREEN | WHITE] No

JSON Object

{"response":{"status":200,"message":"Request completed successfully."},"data":{
  "start_date": "2014-12-07 00:00:00",
  "loc_start_date": "07.12.2014 00:00:00",
  "end_date": null,
  "loc_end_date": null,
  "delivery_date": null,
  "loc_delivery_date": null,
  "estimated_time": 0.0,
  "loc_estimated_time": "00:00",
  "accumulated_time": 600518,
  "is_archived": false,
  "following": false,
  "notes": null,
  "name": "App: Fitnity",
  "tasks": null,
  "task_lists": null,
  "customer": {
    "name": "Enzyme VC",
    "id": 5200
  },
  "service": {
    "name": "iOS Development",
    "id": 899
  },
  "billing": {
    "is_billable": false,
    "hourly_rate": null,
    "loc_hourly_rate": null,
    "hourly_cost": null,
    "loc_hourly_cost": null,
    "fixed_rate": null,
    "loc_fixed_rate": null,
    "billable_hours": 123.28,
    "non_billable_hours": 43.53,
    "loc_billable_hours": "123:16",
    "loc_non_billable_hours": "43:31"
  },
  "worked_hours": 166.81,
  "loc_worked_hours": "166:48",
  "worked_hours_today": 0.0,
  "worked_hours_this_week": 0.0,
  "worked_hours_this_month": 0.0,
  "loc_worked_hours_today": "00:00",
  "loc_worked_hours_this_week": "00:00",
  "loc_worked_hours_this_month": "00:00",
  "active_tasks": 2,
  "archived_tasks": 4,
  "is_template": false,
  "id": 7355,
  "created_at": "2014-06-09 15:02:08",
  "updated_at": "2014-12-31 13:30:38"
}}

Available Endpoints

List Projects

List all account projects.

Action URL

/projects

Parameters

Type Parameter Description Required
String filter [ALL | ACTIVE | ARCHIVED | FOLLOWING]. Default = ACTIVE NO
String include_tasks Set to 'true' to include tasks in the server response. Default = false NO
String include_task_lists Set to 'true' to include task lists in the server response. Default = false NO
String include_billing Set to 'true' to include billing data in the server response. Default = false NO
Boolean include_stats Set to 'true' to include project stats for this week, this month, last month and this year. Default = true NO

Permissions

  • Billing data is only available to account administrators
  • Co-workers only see the projects they have been granted access to

Get Project

Retrieve the project with the given id.

Action URL

/projects/:id

Parameters

Type Parameter Description Required
String include_tasks Set to 'true' to include tasks in the server response. Default = false NO
String include_task_lists Set to 'true' to include task lists in the server response. Default = false NO
String include_billing Set to 'true' to include billing data in the server response. Default = true NO

Permissions

  • Co-workers can only retrieve a project they have been granted access to

Add Project

Add a new project.

Action URL

/projects/add

Parameters

Type Parameter Description Required
String name A human-readable identifier. Project names are not unique. YES
String customer_name Instead of providing a customer ID you can create a new customer on the fly by passing a name in this parameter NO
String service_name Instead of providing a service ID you can create a new service on the fly by passing a name in this parameter NO
Integer template_id The ID of an account project to be used as template. All tasks lists, tasks and to-dos of the template project will be duplicated in the new project. NO

Permissions

  • Only project managers and admins can add new projects

Update Project

Update an existing project.

Action URL

/projects/update/:id

Parameters

Type Parameter Description Required
String customer_name Instead of providing a customer ID you can create a new customer on the fly by passing a name in this parameter NO
String service_name Instead of providing a service ID you can create a new service on the fly by passing a name in this parameter NO

Permissions

  • Project managers and admins can update any project
  • Co-workers can be given permission (can_edit_projects_and_tasks) to update a project which they have been previously given access to

Delete Project

Delete the project with the given project id.

Warning: All tasks and time entries associated to the deleted project will also be deleted.

Action URL

/projects/delete/:id

Permissions

  • Only project managers and admins can delete projects

Archive / Re-open Project

You can archive an re-open your projects any time.

Action URL

/projects/close/:id to archive the project

/projects/open/:id to re-open the project

Permissions

  • Only project managers and admins can archive or re-open projects

List Project Members

List all the users assigned to a project, i.e. they have been assigned at least one project task.

Action URL

projects/:id/users

Permissions

  • Only project managers and admins can view project members

List Projects Times

List the id's and accumulated times in various formats of all account active projects.

Action URL

projects/times

Response

{"response":{"status":200,"message":"ok"},"data":[
  {
    "id": 3704,
    "accumulated_time": 251603,
    "loc_worked_hours": "69:53"
  },
  {
    "id": 5348,
    "accumulated_time": 9709198,
    "loc_worked_hours": "2696:59"
  },
  {
    "id": 7457,
    "accumulated_time": 11434,
    "loc_worked_hours": "03:10"
  }
]}