Your browser is not up to date. This may cause security, speed, and display issues. Please update your browser.
Update Browser
X
Clockodo API:
Manage customers
Endpoint api/v2/customers
All about the endpoint api/v2/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
|
| color | integer |
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
}