clocko:do API:
Manage co-workers

Object type "user"

Parameter Type Description
idinteger
ID of the co-worker
namestring
Name of the co-worker
numberstring|null
Personnel number
emailstring
E-mail-address of the co-worker
rolestring
Role of the co-worker
activeboolean
Is the co-worker active?
timeformat_12hboolean
Is the co-worker using the 12h time format?
weekstart_mondayboolean
Does the week start on Monday for the co-worker?
If not, the week starts on Sunday
weekend_fridayboolean
Is the weekend Friday and Saturday for the co-worker?
If not, it is Saturday and Sunday
languagestring
The co-worker's language
Allowed values: 'de', 'en', 'fr'
timezonestring
The co-worker's timezone
e.g. 'Europe/Berlin'
wage_typeinteger|null
Only relevant for the DATEV export
Allowed values: 1 (salary), 2 (hourly wage)
can_generally_see_absencesboolean
Only editable for co-workers with the role 'worker'
Nur änderbar für Mitarbeiter mit der Rolle 'worker'
can_generally_manage_absencesboolean
Is the co-worker allowed to edit other co-workers' absences?
Only editable for co-workers with the role 'manager'
can_add_customersboolean
Is the co-worker allowed to add customers?
Only editable for co-workers with the role 'worker'
edit_lockstring|null
Fixed edit lock for this co-worker
null (No edit lock)
YYYY-MM-DD (Not editable until)
edit_lock_dyninteger|null
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)
46 (Today and 45 days retroactively editable)
91 (Today and 90 days retroactively editable)
edit_lock_syncboolean|null
Can future changes to the company-wide edit lock overwrite the edit lock for this co-worker?
worktime_regulation_idinteger|null
The worktime regulation applicable to the co-worker
"0" if the co-worker has no worktime regulation
"null" if the company default is applicable
teams_idinteger|null
ID of the team that the co-worker is assigned to
nonbusinessgroups_idinteger|null
ID of the co-worker's nonbusiness group
"0" if the co-worker has no nonbusiness group
"null" if the company default is applicable

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

The parameter mail_to_user determines whether an e-mail should be sent to the new co-worker (default: false).

Optional parameters mail_to_user, number, timeformat_12h, weekstart_monday, weekend_friday, language, timezone, wage_type, can_generally_see_absences, can_generally_manage_absences, can_add_customers, edit_lock_sync, teams_id, nonbusinessgroups_id, worktime_regulation_id
Response
{
  "user": [object of type user]
}

Edit co-workers

Request
PUT /api/users/[ID]
Required parameters none
Optional parameters name, number, active, role, timeformat_12h, weekstart_monday, weekend_friday, language, timezone, wage_type, can_generally_see_absences, can_generally_manage_absences, can_add_customers, edit_lock, edit_lock_dyn, edit_lock_sync, teams_id, nonbusinessgroups_id, worktime_regulation_id
Response
{
  "user": [object of type user]
}

Deactivate co-workers

Request
DELETE /api/users/[ID]
Response
{
  "user": [object of type user]
}
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