clockodo Logo

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/users: Manage co-workers

Object type „user“

Parameter Type Description
id integer ID of the co-worker
name string Name of the co-worker
number string Personnel number
email string E-mail-address of the co-worker
role string Role of the co-worker
active boolean Is the co-worker active?
edit_lock date (YYYY-MM-DD) Fixed edit lock for this co-worker null (No edit lock)
YYYY-MM-DD (Not editable until)
edit_lock_dyn integer Dynamic edit lock for this co-worker null (No edit lock)
1 (Today editable)
2 (Today and yesterday editable)
3 (Today and 2 days retroactively editable)
5 (Today and 4 days retroactively editable)
8 (Today and one week retroactively editable)
15 (Today and 2 weeks retroactively editable)
31 (Today and 30 days retroactively editable)
91 (Today and 90 days retroactively editable)

List co-workers

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

Get co-worker

Request
GET /api/users/[ID]
Response
{
  "user": [object of type user]
}

Add co-workers

Request
POST /api/users
Required parameters name, email, role
Optional parameters number string Personnel number
mail_to_user boolean Should an email be sent to the new co-worker? Default false
Response
{
  "user": [object of type user]
}

Edit co-workers

Request
PUT /api/users/[ID]
Required parameters keine
Optional parameters name, number, active, role, edit_lock, edit_lock_dyn
Response
{
  "user": [object of type user]
}

Deactivate co-workers

Request
DELETE /api/users/[ID]
Response
{
  "user": [object of type user]
}