clocko:do API:
Manage customers

Endpoint api/v2/customers

The first version of this endpoint (api/customers) is deprecated and will not be available after March 31, 2023.

Object type "customer"

Parameter Type Description
idinteger
ID of the customer
namestring
Name of the customer
numberstring|null
Customer number
activeboolean
Is the customer active?
billable_defaultboolean
Is the customer billable by default?
notestring|null
Note for the customer
Only for owners and managers
colorinteger
Color of the customer

List customers

Request
GET /api/v2/customers
Optional parameters filter[active]
boolean|null

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

Response
{
  "paging": [paging information],
  "customers": 
  {
    [object of type customer],
    [object of type customer], 
    ...
  }
}

Search for customers

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

Add customers

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

Edit customers

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

Delete customers

Request
DELETE /api/v2/customers/[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