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/customers: Manage customers


Object type „customer“

Parameter Type Description
id integer ID of the customer
name string Name of the customer
number string|null Customer number
active boolean Is the customer active?
billable_default boolean Is the customer billable by default?
note string|null Note for the customer Only for owners and managers
[projects] array|null List of all projects belonging to the customer Only in list mode; will not be delivered when a single customer is queried

List customers

Request
GET /api/customers
Response
{
  "customers": 
  {
    [object of type customer],
    [object of type customer], 
    ...
  }
}

Search for customers

Request
GET /api/customers/[ID]
Response
{
  "customer": [object of type customer]
}

Add customers

Request
POST /api/customers
Required parameters name
Optional parameters number, active, billable_default, note
Response
{
  "customer": [object of type customer]
}

Edit customers

Request
PUT /api/customers/[ID]
Optional parameters name, number, active, billable_default, note

Deactivate customers

Request
DELETE /api/customers/[ID]
Response
{
  "customer": [object of type customer]
}