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/v2/aggregates/users/me: Query user and company settings

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


Object type "company"

Parameter Type Description
id integer ID of the company
name string Name of the company
timezone_default string Defaul timezone of the company
currency string Currency of the company
allow_entries_multiline boolean Are time and lump sum entries with multiline descriptions allowed?
allow_entries_for_customers boolean Can time and lump sum entries be directly assigned to customers (or only to projects)?
force_linked_entry_times boolean Does the duration of a time entry have to be equal to the difference between start and end?
default_customers_id integer|null ID of the default customer
default_services_id integer|null ID of the default service
module_absence boolean Is the absence module active for the company?
module_target_hours boolean Is the target hours module active for the company?
module_user_reports boolean Is the user report module active for the company?
nonbusiness_group_default integer|null ID of the default nonbusiness group
worktime_regulation_default integer|null ID of the default worktime regulation
worktime_evaluate_regulations_since string|null Date from which worktime regulations are evaluated for the company in YYYY-MM-DD format
worktime_force_breaks boolean Is missing break time subtracted from the tracked work time?
holidays_count_default float Number of days in the default holiday quota of the company
absence_reduces_target_hours boolean Are absences handled by reducing the target hours for the day? If not, time is added to the worktime account for absences
compensate_day_default float Default value for automatically compensated overtime per day (in minutes)
compensate_month_default float 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_complete boolean Has the registration process been completed?

Object type "worktime_regulation"

Parameter Type Description
id integer ID of the worktime regulation
add_to_worktime boolean Do mandatory breaks count as worktime?
weekly_max float Maximum allowed worktime per week (in hours)
daily_max float Maximum allowed worktime per day (in hours)
interval_max float Maximum allowed worktime without a break (in hours)
rules array contains objects of the type "breakrule"

Object type "breakrule"

Parameter Type Description
worktime float daily worktime (in hours), above which the rule applies
break_sum integer Required total break time
rules object contains the break splitting options as key-value pai 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]