clocko:do API:
Query user and company settings

Endpoint api/v2/aggregates/users/me

With this resource you can read user and company settings for the logged in user. Editing is currently not possible.

Object type "company"

Parameter Type Description
idinteger
ID of the company
namestring
Name of the company
timezone_defaultstring
Defaul timezone of the company
currencystring
Currency of the company
allow_entries_multilineboolean
Are time and lump sum entries with multiline descriptions allowed?
allow_entries_for_customersboolean
Can time and lump sum entries be directly assigned to customers (or only to projects)?
force_linked_entry_timesboolean
Does the duration of a time entry have to be equal to the difference between start and end?
default_customers_idinteger|null
ID of the default customer
default_services_idinteger|null
ID of the default service
module_absenceboolean
Is the absence module active for the company?
module_target_hoursboolean
Is the target hours module active for the company?
module_user_reportsboolean
Is the user report module active for the company?
nonbusiness_group_defaultinteger|null
ID of the default nonbusiness group
worktime_regulation_defaultinteger|null
ID of the default worktime regulation
worktime_evaluate_regulations_sincestring|null
Date from which worktime regulations are evaluated for the company
in YYYY-MM-DD format
worktime_force_breaksinteger
Subtraction of missing break time
0: no subtraction
1: full subtraction
2: full subtraction / floating subtraction as of 2022
holidays_count_defaultfloat
Number of days in the default holiday quota of the company
absence_reduces_target_hoursboolean
Are absences handled by reducing the target hours for the day?
If not, time is added to the worktime account for absences
compensate_day_defaultfloat
Default value for automatically compensated overtime per day (in minutes)
compensate_month_defaultfloat
Default value for automatically compensated overtime per month (in hours)
target_hours_default[monday]float
Default value for targethours on mondays
target_hours_default[tuesday]float
Default value for targethours on tuesdays
target_hours_default[wednesday]float
Default value for targethours on wednesdays
target_hours_default[thursday]float
Default value for targethours on thursdays
target_hours_default[friday]float
Default value for targethours on fridays
target_hours_default[saturday]float
Default value for targethours on saturdays
target_hours_default[sunday]float
Default value for targethours on sundays
onboarding_completeboolean
Has the registration process been completed?

Object type "worktime_regulation"

Parameter Type Description
idinteger
ID of the worktime regulation
add_to_worktimeboolean
Do mandatory breaks count as worktime?
weekly_maxfloat|null
Maximum allowed worktime per week (in hours)
daily_maxfloat|null
Maximum allowed worktime per day (in hours)
interval_maxfloat|null
Maximum allowed worktime without a break (in hours)
rulesarray
contains objects of the type "breakrule"

Object type "breakrule"

Parameter Type Description
worktimefloat
daily worktime (in hours), above which the rule applies
break_suminteger
Required total break time
splittingobject|null
contains the break splitting options as key-value pairs
The key represents the number of breaks into which the required time may be split, the value contains the minimum length of a single break (in minutes)

Query settings

Request
GET /api/v2/aggregates/users/me
Response
{
    "user": [object of type user],
    "company": [object of type company], 
    "worktime_regulation": [object of type worktime_regulation]
}

Please refer to the description of the object type "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