Clockodo API:
Manage projects

Endpoint api/v2/projects

Feel free to use our updated API documentation.

Parameter	Type	Description
id	integer	ID of the project
customers_id	integer	ID of the corresponding customer
name	string	Name of the project
number	string\|null	Project number
active	boolean	Is the project active?
billable_default	boolean	Is the project billable by default? (1 or 0)
note	string\|null	Note for the project Only with necessary access rights
budget_money	float\|null	Budget for the project Only with necessary access rights
budget_is_hours	boolean	Is the budget based on hours? Only with necessary access rights
budget_is_not_strict	boolean	Is the budget not strict? Only with necessary access rights
completed	boolean	Is the project completed?
billed_money	float\|null	Billed amount of money Only with necessary access rights
billed_completely	boolean\|null	Is the project billed completely? Only with necessary access rights
revenue_factor	float\|null	Factor with which revenues and hourly rates have to multiplicated in order to get the effective values Only with necessary access rights. In case of a project which has a hard budget and has been completed with a budget usage of 400%, the factor is "0.25". "null" if a project with hard budget hasn't been completed yet. "1" for projects without or with soft budget.
deadline	string\|null	Project deadline date in the format YYYY-MM-DD

Request

GET /api/v2/projects

Optional parameters	filter[customers_id]	integer
	filter[active]	boolean\|null

Because the result can have many projects, the use of page-by-page output is enabled for this request.

Response

{
  "paging": [paging information],
  "projects": 
  {
    [object of type project],
    [object of type project], 
    ...
  }
}

Request

GET /api/v2/projects/[ID]

Response

{
  "project": [object of type project]
}

Request

POST /api/v2/projects

Required parameters	name, customers_id

Optional parameters	number, active, billable_default, budget_money, budget_is_hours, budget_is_not_strict, note, deadline

Response

{
  "project": [object of type project]
}

Request

PUT /api/v2/projects/[ID]

Required parameters	none

Optional parameters	name, number, active, billable_default, budget_money, budget_is_hours, budget_ist_not_strict, note, customers_id, completed, billed_money, billed_completely, deadline

Response

{
  "project": [object of type project]
}

Request

DELETE /api/v2/projects/[ID]

Response

{
  "success": true
}

Contact us!

Our Customer-Success-Team will answer your questions.