REST-API

The clockodo API allows you to connect clockodo to other systems. Accounting and project management applications or proprietary shell scripts are examples of useful mash-ups with clockodo.

api/tasks: Tasks (grouped entries)

Object type „task“

Parameter	Type	Description
day	string	Day on which the task has been executed in YYYY-MM-DD format
customers_id	integer	ID of the corresponding customer
customers_name	string	Name of the corresponding customer
projects_id	integer	ID of the corresponding project
projects_name	string	Name of the corresponding project
services_id	integer	ID of the corresponding service
services_name	string	Name of the corresponding service
lumpSums_id	integer	ID of the corresponding lump sum
lumpSums_amount	float	Amount of the corresponding lump sum
lumpSums_name	string	Name of the corresponding lump sum
lumpSums_price	float	Price per unit of the corresponding lump sum
lumpSums_unit	string	Unit of the corresponding lump sum
users_id	integer	ID of the corresponding co-worker
billable	integer	Is the task billable? (1 or 0)
texts_id	integer	ID of the text description
text_id	integer	ID of the text description
text	string	Text description
time_since	string	Starting time (e.g. in format “YYYY-MM-DD HH:MM:SS”; see section “Localisation”)
time_until	string	End time, NULL if entry is running (e.g. in format “YYYY-MM-DD HH:MM:SS”; see section “Localisation”)
duration	integer	Duration in seconds
duration_time	string	Duration in HH:MM:SS format
duration_text	string	Localized duration
is_clocking	boolean	Task is currently running
has_just_lumpSums	boolean	Has the task just lump sums?
[revenue]	float	Revenue of the task (only with necessary access rights)

List tasks of the past days

Request

GET /api/tasks

Required parameters	none

Optional parameters	count (integer, count of days for which the tasks will be listed, default 8, max. 30)

Response

{
  "days":
  {
    {
      "date": [date in YYYY-MM-DD],
      "date_text": [date localized],
      "duration": [duration in seconds, integer],
      "duration_text": [duration in H:MM h],
      "tasks":
      {
        [object of type task],
        [object of type task],
		...
      }
    },
    ...
  }
}

Get the duration for a task

Provides the duration of the task in seconds

Request

GET /api/tasks/duration

Required parameters	task[customers_id], task[projects_id], task[services_id] or task[lumpSum_id], task[text], task[billable]

Optional parameters	excludeIds (list of entry-Ids which should not be included in the duration)

Response

{
  "task": 
  {
    "duration": integer
  }
}