clocko:do API:
Manage projects

Endpoint api/v2/projects

The first version of this endpoint (api/projects) is deprecated and will not be available after Dec 31, 2022.

Object type "project"

Parameter Type Description
idinteger
ID of the project
customers_idinteger
ID of the corresponding customer
namestring
Name of the project
numberstring|null
Project number
activeboolean
Is the project active?
billable_defaultboolean
Is the project billable by default? (1 or 0)
notestring|null
Note for the project
Only with necessary access rights
budget_moneyfloat|null
Budget for the project
Only with necessary access rights
budget_is_hoursboolean
Is the budget based on hours?
Only with necessary access rights
budget_is_not_strictboolean
Is the budget not strict?
Only with necessary access rights
completedboolean
Is the project completed?
billed_moneyfloat|null
Billed amount of money
Only with necessary access rights
billed_completelyboolean|null
Is the project billed completely?
Only with necessary access rights
revenue_factorfloat|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.

List projects

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], 
    ...
  }
}

Get project

Request
GET /api/v2/projects/[ID]
Response
{
  "project": [object of type project]
}

Add projects

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
Response
{
  "project": [object of type project]
}

Edit projects

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, hourly_rate, customers_id, completed, billed_money, billed_completely
Response
{
  "project": [object of type project]
}

Delete projects

Request
DELETE /api/v2/projects/[ID]
Response
{
  "success": true
}
stripes illustration
Contact us!

Our Customer-Success-Team will answer your questions.

Contact now!

Test all functions 14 days free of charge

By submitting this form you accept our terms and conditions and our privacy policy and you confirm that you will use clockodo as a commercial user.

Take advantage of the experience of 6,000 other companies:

Bechtle Mannheim LogoBechtlePeerigon LogoPeerigon GmbH
Phoenix Logistik LogoPhoenix LogistikFieda LogoFidea