Skip to main content

Preferences

GET Preferences for the current user

https://api.track.toggl.com/api/v9/me/preferences

Returns user preferences and alpha features. The list of alpha features contains a full list of feature codes (every feature that exists in database) and the enabled flag specifying if that feature should be enabled or disabled for the user.

curl  https://api.track.toggl.com/api/v9/me/preferences \
-H "Content-Type: application/json" \
-u <email>:<password>

Response

200

NameTypeDescription
activity_timeline_display_activityboolean-
activity_timeline_grouping_intervalstring-
activity_timeline_grouping_methodstring-
activity_timeline_recording_levelstring-
activity_timeline_sync_eventsboolean-
alpha_featuresArray of objectwill be omitted if empty
analyticsAdvancedFiltersbooleanwill be omitted if empty
auto_tracker_delay_enabledboolean-
auto_tracker_delay_in_secondsinteger-
automatic_taggingboolean-
autotracking_enabledboolean-
beginningOfWeekintegerwill be omitted if empty
calendar_snap_durationstring-
calendar_snap_initial_locationstring-
calendar_visible_hours_endinteger-
calendar_visible_hours_startinteger-
calendar_zoom_levelstring-
cell_swipe_actions_enabledboolean-
charts_view_typestring-
collapseDetailedReportEntriesbooleanwill be omitted if empty
collapseTimeEntriesbooleanwill be omitted if empty
dashboards_view_typestring-
date_formatstring-
decimal_separatorstringwill be omitted if empty
default_project_idinteger-
default_task_idinteger-
displayDensitystringwill be omitted if empty
distinctRatesstringwill be omitted if empty
duration_formatstring-
duration_format_on_timer_duration_fieldboolean-
edit_popup_integration_timerboolean-
extension_send_error_reportsboolean-
extension_send_usage_statisticsboolean-
firstSeenBusinessPromointegerwill be omitted if empty
focus_app_on_time_entry_startedboolean-
focus_app_on_time_entry_stoppedboolean-
haptic_feedback_enabledboolean-
hide_keyboard_shortcutbooleanwill be omitted if empty
idle_detection_enabledboolean-
idle_detection_interval_in_minutesinteger-
inactivity_behaviorstring-
ios_is_goals_view_shownboolean-
is_goals_view_expandedboolean-
is_goals_view_shownboolean-
is_summary_total_view_visibleboolean-
keep_mini_timer_on_topboolean-
keep_window_on_topboolean-
keyboard_increment_timer_pageinteger-
keyboard_shortcuts_enabledbooleanwill be omitted if empty
keyboard_shortcuts_share_time_entriesboolean-
mac_is_goals_view_shownboolean-
macos_auto_tracking_rulesArray of object-
macos_show_hide_toggl_keyboard_shortcutobject-
macos_stop_continue_keyboard_shortcutobject-
manualEntryModestringwill be omitted if empty
manualModebooleanwill be omitted if empty
manualModeOverlaySeenbooleanwill be omitted if empty
modify_on_start_time_changestring-
offlineModestringwill be omitted if empty
pg_time_zone_namestring-
pomodoro_auto_start_breakboolean-
pomodoro_auto_start_focusboolean-
pomodoro_break_interval_in_minutesinteger-
pomodoro_break_project_idinteger-
pomodoro_break_start_sound_enabledboolean-
pomodoro_break_tag_idinteger-
pomodoro_countdown_timerboolean-
pomodoro_enabledboolean-
pomodoro_focus_interval_in_minutesinteger-
pomodoro_focus_soundstring-
pomodoro_global_sound_enabledboolean-
pomodoro_interval_end_soundboolean-
pomodoro_interval_end_volumeinteger-
pomodoro_longer_break_duration_in_minutesinteger-
pomodoro_prevent_screen_lockboolean-
pomodoro_rounds_before_longer_breakinteger-
pomodoro_session_start_sound_enabledboolean-
pomodoro_show_notificationsboolean-
pomodoro_stop_timer_at_interval_endboolean-
pomodoro_track_breaks_as_time_entriesboolean-
projectDashboardActivityModestringwill be omitted if empty
project_shortcut_enabledboolean-
record_timelineboolean-
remember_last_projectstring-
reminder_daysstring-
reminder_enabledboolean-
reminder_interval_in_minutesinteger-
reminder_periodstring-
reminder_snoozing_in_minutesinteger-
reportRoundingbooleanwill be omitted if empty
reportRoundingDirectionstringwill be omitted if empty
reportRoundingStepInMinutesintegerwill be omitted if empty
reportsHideWeekendsbooleanwill be omitted if empty
run_app_on_startupboolean-
running_entry_warningstring-
running_timer_notification_enabledboolean-
seenFollowModalbooleanwill be omitted if empty
seenFooterPopupbooleanwill be omitted if empty
seenProjectDashboardOverlaybooleanwill be omitted if empty
seenTogglButtonModalbooleanwill be omitted if empty
send_daily_project_invitesboolean-
send_product_emailsboolean-
send_timer_notificationsboolean-
send_weekly_reportboolean-
sharing_shortcut_enabledboolean-
showTimeInTitlebooleanwill be omitted if empty
show_all_entriesboolean-
show_changelogboolean-
show_description_in_menu_barboolean-
show_dock_iconboolean-
show_events_in_calendarboolean-
show_project_in_menu_barboolean-
show_qr_scannerboolean-
show_seconds_in_menu_barboolean-
show_timeline_in_day_viewbooleanwill be omitted if empty
show_timer_in_menu_barboolean-
show_today_total_in_menu_barboolean-
show_total_billable_hoursbooleanwill be omitted if empty
show_weekend_on_timer_pagebooleanwill be omitted if empty
show_workouts_in_calendarboolean-
sleep_behaviourstring-
smart_alerts_optionstring-
snowballReportRoundingstringwill be omitted if empty
stack_times_on_manual_mode_afterstring-
start_automaticallyboolean-
start_shortcut_modestring-
stop_at_specific_timeboolean-
stop_automaticallyboolean-
stop_entry_on_shutdownboolean-
stop_specified_timestring-
stopped_timer_notification_enabledboolean-
suggestions_enabledboolean-
summaryReportAmountsstringwill be omitted if empty
summaryReportDistinctRatesbooleanwill be omitted if empty
summaryReportGroupingstringwill be omitted if empty
summaryReportSortAscbooleanwill be omitted if empty
summaryReportSortFieldstringwill be omitted if empty
summaryReportSubGroupingstringwill be omitted if empty
summary_total_modestring-
tags_shortcut_enabledboolean-
themestringwill be omitted if empty
time_entry_display_modestring-
time_entry_ghost_suggestions_enabledboolean-
time_entry_invitations_notification_enabledboolean-
time_entry_start_stop_input_modestring-
timeofday_formatstring-
timerViewstringwill be omitted if empty
timerViewMobilestringwill be omitted if empty
toSAcceptNeededbooleanToSAcceptNeeded represents the trigger for new ToS accept dialog
use_mini_timerboolean-
visibleFooterstringwill be omitted if empty
webTimeEntryStartedbooleanwill be omitted if empty
webTimeEntryStoppedbooleanwill be omitted if empty
weeklyReportGroupingstringwill be omitted if empty
weeklyReportValueToShowstringwill be omitted if empty
windows_auto_tracking_rulesArray of object-
windows_show_hide_toggl_keyboard_shortcutobject-
windows_stop_continue_keyboard_shortcutobject-
windows_stop_start_keyboard_shortcutobject-
windows_themestring-
workout_default_project_idinteger-
workout_default_tag_idinteger-
alpha_features
NameTypeDescription
alpha_feature_idintegerFeature ID
codestringFeature code
deleted_atstringTime of deletion, omitted if empty
descriptionstringFeature description, omitted if empty
enabledbooleanWhether the feature is enabled
macos_auto_tracking_rules
NameTypeDescription
idstring-
keywordstring-
project_idinteger-
task_idinteger-
macos_show_hide_toggl_keyboard_shortcut
NameTypeDescription
keyinteger-
modifiersinteger-
macos_stop_continue_keyboard_shortcut
NameTypeDescription
keyinteger-
modifiersinteger-
windows_auto_tracking_rules
NameTypeDescription
billableboolean-
descriptionstring-
enabledboolean-
idstring-
parametersobject-
project_idinteger-
skip_when_timer_is_runningboolean-
start_without_confirmationboolean-
tag_idsArray of integer-
task_idinteger-
typeinteger-
parameters
NameTypeDescription
durationstring-
keywordstring-
keyword_modestring-
time_of_daystring-
week_daysstring-
windows_show_hide_toggl_keyboard_shortcut
NameTypeDescription
keyinteger-
modifiersinteger-
windows_stop_continue_keyboard_shortcut
NameTypeDescription
keyinteger-
modifiersinteger-
windows_stop_start_keyboard_shortcut
NameTypeDescription
keyinteger-
modifiersinteger-

403

User does not have access to this resource.

500

Internal Server Error

POST Update the preferences for the current user

https://api.track.toggl.com/api/v9/me/preferences

With this endpoint, preferences can be modified and alpha features can be enabled or disabled.

curl -X POST https://api.track.toggl.com/api/v9/me/preferences \
-H "Content-Type: application/json" \
-d '\{"activity_timeline_display_activity":"boolean","activity_timeline_grouping_interval":"string","activity_timeline_grouping_method":"string","activity_timeline_recording_level":"string","activity_timeline_sync_events":"boolean","alpha_features":[\{"alpha_feature_id":"integer","code":"string","deleted_at":"string","description":"string","enabled":"boolean"\}],"analyticsAdvancedFilters":"boolean","auto_tracker_delay_enabled":"boolean","auto_tracker_delay_in_seconds":"integer","automatic_tagging":"boolean","autotracking_enabled":"boolean","beginningOfWeek":"integer","calendar_snap_duration":"string","calendar_snap_initial_location":"string","calendar_visible_hours_end":"integer","calendar_visible_hours_start":"integer","calendar_zoom_level":"string","cell_swipe_actions_enabled":"boolean","charts_view_type":"string","collapseDetailedReportEntries":"boolean","collapseTimeEntries":"boolean","dashboards_view_type":"string","date_format":"string","decimal_separator":"string","default_project_id":"integer","default_task_id":"integer","displayDensity":"string","distinctRates":"string","duration_format":"string","duration_format_on_timer_duration_field":"boolean","edit_popup_integration_timer":"boolean","extension_send_error_reports":"boolean","extension_send_usage_statistics":"boolean","firstSeenBusinessPromo":"integer","focus_app_on_time_entry_started":"boolean","focus_app_on_time_entry_stopped":"boolean","haptic_feedback_enabled":"boolean","hide_keyboard_shortcut":"boolean","idle_detection_enabled":"boolean","idle_detection_interval_in_minutes":"integer","inactivity_behavior":"string","ios_is_goals_view_shown":"boolean","is_goals_view_expanded":"boolean","is_goals_view_shown":"boolean","is_summary_total_view_visible":"boolean","keep_mini_timer_on_top":"boolean","keep_window_on_top":"boolean","keyboard_increment_timer_page":"integer","keyboard_shortcuts_enabled":"boolean","keyboard_shortcuts_share_time_entries":"boolean","mac_is_goals_view_shown":"boolean","macos_auto_tracking_rules":[\{"id":"string","keyword":"string","project_id":"integer","task_id":"integer"\}],"macos_show_hide_toggl_keyboard_shortcut":\{"key":"integer","modifiers":"integer"\},"macos_stop_continue_keyboard_shortcut":\{"key":"integer","modifiers":"integer"\},"manualEntryMode":"string","manualMode":"boolean","manualModeOverlaySeen":"boolean","modify_on_start_time_change":"string","offlineMode":"string","pg_time_zone_name":"string","pomodoro_auto_start_break":"boolean","pomodoro_auto_start_focus":"boolean","pomodoro_break_interval_in_minutes":"integer","pomodoro_break_project_id":"integer","pomodoro_break_start_sound_enabled":"boolean","pomodoro_break_tag_id":"integer","pomodoro_countdown_timer":"boolean","pomodoro_enabled":"boolean","pomodoro_focus_interval_in_minutes":"integer","pomodoro_focus_sound":"string","pomodoro_global_sound_enabled":"boolean","pomodoro_interval_end_sound":"boolean","pomodoro_interval_end_volume":"integer","pomodoro_longer_break_duration_in_minutes":"integer","pomodoro_prevent_screen_lock":"boolean","pomodoro_rounds_before_longer_break":"integer","pomodoro_session_start_sound_enabled":"boolean","pomodoro_show_notifications":"boolean","pomodoro_stop_timer_at_interval_end":"boolean","pomodoro_track_breaks_as_time_entries":"boolean","projectDashboardActivityMode":"string","project_shortcut_enabled":"boolean","record_timeline":"boolean","remember_last_project":"string","reminder_days":"string","reminder_enabled":"boolean","reminder_interval_in_minutes":"integer","reminder_period":"string","reminder_snoozing_in_minutes":"integer","reportRounding":"boolean","reportRoundingDirection":"string","reportRoundingStepInMinutes":"integer","reportsHideWeekends":"boolean","run_app_on_startup":"boolean","running_entry_warning":"string","running_timer_notification_enabled":"boolean","seenFollowModal":"boolean","seenFooterPopup":"boolean","seenProjectDashboardOverlay":"boolean","seenTogglButtonModal":"boolean","send_daily_project_invites":"boolean","send_product_emails":"boolean","send_timer_notifications":"boolean","send_weekly_report":"boolean","sharing_shortcut_enabled":"boolean","showTimeInTitle":"boolean","show_all_entries":"boolean","show_changelog":"boolean","show_description_in_menu_bar":"boolean","show_dock_icon":"boolean","show_events_in_calendar":"boolean","show_project_in_menu_bar":"boolean","show_qr_scanner":"boolean","show_seconds_in_menu_bar":"boolean","show_timeline_in_day_view":"boolean","show_timer_in_menu_bar":"boolean","show_today_total_in_menu_bar":"boolean","show_total_billable_hours":"boolean","show_weekend_on_timer_page":"boolean","show_workouts_in_calendar":"boolean","sleep_behaviour":"string","smart_alerts_option":"string","snowballReportRounding":"string","stack_times_on_manual_mode_after":"string","start_automatically":"boolean","start_shortcut_mode":"string","stop_at_specific_time":"boolean","stop_automatically":"boolean","stop_entry_on_shutdown":"boolean","stop_specified_time":"string","stopped_timer_notification_enabled":"boolean","suggestions_enabled":"boolean","summaryReportAmounts":"string","summaryReportDistinctRates":"boolean","summaryReportGrouping":"string","summaryReportSortAsc":"boolean","summaryReportSortField":"string","summaryReportSubGrouping":"string","summary_total_mode":"string","tags_shortcut_enabled":"boolean","theme":"string","time_entry_display_mode":"string","time_entry_ghost_suggestions_enabled":"boolean","time_entry_invitations_notification_enabled":"boolean","time_entry_start_stop_input_mode":"string","timeofday_format":"string","timerView":"string","timerViewMobile":"string","toSAcceptNeeded":"boolean","use_mini_timer":"boolean","visibleFooter":"string","webTimeEntryStarted":"boolean","webTimeEntryStopped":"boolean","weeklyReportGrouping":"string","weeklyReportValueToShow":"string","windows_auto_tracking_rules":[\{"billable":"boolean","description":"string","enabled":"boolean","id":"string","parameters":\{"duration":"string","keyword":"string","keyword_mode":"string","time_of_day":"string","week_days":"string"\},"project_id":"integer","skip_when_timer_is_running":"boolean","start_without_confirmation":"boolean","tag_ids":[\{\}],"task_id":"integer","type":"integer"\}],"windows_show_hide_toggl_keyboard_shortcut":\{"key":"integer","modifiers":"integer"\},"windows_stop_continue_keyboard_shortcut":\{"key":"integer","modifiers":"integer"\},"windows_stop_start_keyboard_shortcut":\{"key":"integer","modifiers":"integer"\},"windows_theme":"string","workout_default_project_id":"integer","workout_default_tag_id":"integer"\}' \
-u <email>:<password>

Parameters

Body

NameTypeDescription
activity_timeline_display_activityboolean-
activity_timeline_grouping_intervalstring-
activity_timeline_grouping_methodstring-
activity_timeline_recording_levelstring-
activity_timeline_sync_eventsboolean-
alpha_featuresArray of objectwill be omitted if empty
analyticsAdvancedFiltersbooleanwill be omitted if empty
auto_tracker_delay_enabledboolean-
auto_tracker_delay_in_secondsinteger-
automatic_taggingboolean-
autotracking_enabledboolean-
beginningOfWeekintegerwill be omitted if empty
calendar_snap_durationstring-
calendar_snap_initial_locationstring-
calendar_visible_hours_endinteger-
calendar_visible_hours_startinteger-
calendar_zoom_levelstring-
cell_swipe_actions_enabledboolean-
charts_view_typestring-
collapseDetailedReportEntriesbooleanwill be omitted if empty
collapseTimeEntriesbooleanwill be omitted if empty
dashboards_view_typestring-
date_formatstring-
decimal_separatorstringwill be omitted if empty
default_project_idinteger-
default_task_idinteger-
displayDensitystringwill be omitted if empty
distinctRatesstringwill be omitted if empty
duration_formatstring-
duration_format_on_timer_duration_fieldboolean-
edit_popup_integration_timerboolean-
extension_send_error_reportsboolean-
extension_send_usage_statisticsboolean-
firstSeenBusinessPromointegerwill be omitted if empty
focus_app_on_time_entry_startedboolean-
focus_app_on_time_entry_stoppedboolean-
haptic_feedback_enabledboolean-
hide_keyboard_shortcutbooleanwill be omitted if empty
idle_detection_enabledboolean-
idle_detection_interval_in_minutesinteger-
inactivity_behaviorstring-
ios_is_goals_view_shownboolean-
is_goals_view_expandedboolean-
is_goals_view_shownboolean-
is_summary_total_view_visibleboolean-
keep_mini_timer_on_topboolean-
keep_window_on_topboolean-
keyboard_increment_timer_pageinteger-
keyboard_shortcuts_enabledbooleanwill be omitted if empty
keyboard_shortcuts_share_time_entriesboolean-
mac_is_goals_view_shownboolean-
macos_auto_tracking_rulesArray of object-
macos_show_hide_toggl_keyboard_shortcutobject-
macos_stop_continue_keyboard_shortcutobject-
manualEntryModestringwill be omitted if empty
manualModebooleanwill be omitted if empty
manualModeOverlaySeenbooleanwill be omitted if empty
modify_on_start_time_changestring-
offlineModestringwill be omitted if empty
pg_time_zone_namestring-
pomodoro_auto_start_breakboolean-
pomodoro_auto_start_focusboolean-
pomodoro_break_interval_in_minutesinteger-
pomodoro_break_project_idinteger-
pomodoro_break_start_sound_enabledboolean-
pomodoro_break_tag_idinteger-
pomodoro_countdown_timerboolean-
pomodoro_enabledboolean-
pomodoro_focus_interval_in_minutesinteger-
pomodoro_focus_soundstring-
pomodoro_global_sound_enabledboolean-
pomodoro_interval_end_soundboolean-
pomodoro_interval_end_volumeinteger-
pomodoro_longer_break_duration_in_minutesinteger-
pomodoro_prevent_screen_lockboolean-
pomodoro_rounds_before_longer_breakinteger-
pomodoro_session_start_sound_enabledboolean-
pomodoro_show_notificationsboolean-
pomodoro_stop_timer_at_interval_endboolean-
pomodoro_track_breaks_as_time_entriesboolean-
projectDashboardActivityModestringwill be omitted if empty
project_shortcut_enabledboolean-
record_timelineboolean-
remember_last_projectstring-
reminder_daysstring-
reminder_enabledboolean-
reminder_interval_in_minutesinteger-
reminder_periodstring-
reminder_snoozing_in_minutesinteger-
reportRoundingbooleanwill be omitted if empty
reportRoundingDirectionstringwill be omitted if empty
reportRoundingStepInMinutesintegerwill be omitted if empty
reportsHideWeekendsbooleanwill be omitted if empty
run_app_on_startupboolean-
running_entry_warningstring-
running_timer_notification_enabledboolean-
seenFollowModalbooleanwill be omitted if empty
seenFooterPopupbooleanwill be omitted if empty
seenProjectDashboardOverlaybooleanwill be omitted if empty
seenTogglButtonModalbooleanwill be omitted if empty
send_daily_project_invitesboolean-
send_product_emailsboolean-
send_timer_notificationsboolean-
send_weekly_reportboolean-
sharing_shortcut_enabledboolean-
showTimeInTitlebooleanwill be omitted if empty
show_all_entriesboolean-
show_changelogboolean-
show_description_in_menu_barboolean-
show_dock_iconboolean-
show_events_in_calendarboolean-
show_project_in_menu_barboolean-
show_qr_scannerboolean-
show_seconds_in_menu_barboolean-
show_timeline_in_day_viewbooleanwill be omitted if empty
show_timer_in_menu_barboolean-
show_today_total_in_menu_barboolean-
show_total_billable_hoursbooleanwill be omitted if empty
show_weekend_on_timer_pagebooleanwill be omitted if empty
show_workouts_in_calendarboolean-
sleep_behaviourstring-
smart_alerts_optionstring-
snowballReportRoundingstringwill be omitted if empty
stack_times_on_manual_mode_afterstring-
start_automaticallyboolean-
start_shortcut_modestring-
stop_at_specific_timeboolean-
stop_automaticallyboolean-
stop_entry_on_shutdownboolean-
stop_specified_timestring-
stopped_timer_notification_enabledboolean-
suggestions_enabledboolean-
summaryReportAmountsstringwill be omitted if empty
summaryReportDistinctRatesbooleanwill be omitted if empty
summaryReportGroupingstringwill be omitted if empty
summaryReportSortAscbooleanwill be omitted if empty
summaryReportSortFieldstringwill be omitted if empty
summaryReportSubGroupingstringwill be omitted if empty
summary_total_modestring-
tags_shortcut_enabledboolean-
themestringwill be omitted if empty
time_entry_display_modestring-
time_entry_ghost_suggestions_enabledboolean-
time_entry_invitations_notification_enabledboolean-
time_entry_start_stop_input_modestring-
timeofday_formatstring-
timerViewstringwill be omitted if empty
timerViewMobilestringwill be omitted if empty
toSAcceptNeededbooleanToSAcceptNeeded represents the trigger for new ToS accept dialog
use_mini_timerboolean-
visibleFooterstringwill be omitted if empty
webTimeEntryStartedbooleanwill be omitted if empty
webTimeEntryStoppedbooleanwill be omitted if empty
weeklyReportGroupingstringwill be omitted if empty
weeklyReportValueToShowstringwill be omitted if empty
windows_auto_tracking_rulesArray of object-
windows_show_hide_toggl_keyboard_shortcutobject-
windows_stop_continue_keyboard_shortcutobject-
windows_stop_start_keyboard_shortcutobject-
windows_themestring-
workout_default_project_idinteger-
workout_default_tag_idinteger-
alpha_features
NameTypeDescription
alpha_feature_idintegerFeature ID
codestringFeature code
deleted_atstringTime of deletion, omitted if empty
descriptionstringFeature description, omitted if empty
enabledbooleanWhether the feature is enabled
macos_auto_tracking_rules
NameTypeDescription
idstring-
keywordstring-
project_idinteger-
task_idinteger-
macos_show_hide_toggl_keyboard_shortcut
NameTypeDescription
keyinteger-
modifiersinteger-
macos_stop_continue_keyboard_shortcut
NameTypeDescription
keyinteger-
modifiersinteger-
windows_auto_tracking_rules
NameTypeDescription
billableboolean-
descriptionstring-
enabledboolean-
idstring-
parametersobject-
project_idinteger-
skip_when_timer_is_runningboolean-
start_without_confirmationboolean-
tag_idsArray of integer-
task_idinteger-
typeinteger-
parameters
NameTypeDescription
durationstring-
keywordstring-
keyword_modestring-
time_of_daystring-
week_daysstring-
windows_show_hide_toggl_keyboard_shortcut
NameTypeDescription
keyinteger-
modifiersinteger-
windows_stop_continue_keyboard_shortcut
NameTypeDescription
keyinteger-
modifiersinteger-
windows_stop_start_keyboard_shortcut
NameTypeDescription
keyinteger-
modifiersinteger-

Response

200

Successful operation.

400

Possible error messages:

  • Cannot set value for ToSAcceptNeeded
  • Invalid feature code(s)
  • Missing data
  • Value in date_format is invalid
  • Value in timeofday_format is invalid

403

User does not have access to this resource.

500

Internal Server Error

GET Preferences for an specific client of the current user

https://api.track.toggl.com/api/v9/me/preferences/{client}

Returns user preferences and alpha features. The list of alpha features contains a full list of feature codes (every feature that exists in database) and the enabled flag specifying if that feature should be enabled or disabled for the user.

curl  https://api.track.toggl.com/api/v9/me/preferences/{client} \
-H "Content-Type: application/json" \
-u <email>:<password>

Parameters

Path

nametyperequireddescription
clientstringfalseClient type

Query

nametyperequireddescription
sinceintegerfalseRetrieve preference modified since this date using UNIX timestamp.

Response

200

NameTypeDescription
activity_timeline_display_activityboolean-
activity_timeline_grouping_intervalstring-
activity_timeline_grouping_methodstring-
activity_timeline_recording_levelstring-
activity_timeline_sync_eventsboolean-
alpha_featuresArray of objectwill be omitted if empty
analyticsAdvancedFiltersbooleanwill be omitted if empty
auto_tracker_delay_enabledboolean-
auto_tracker_delay_in_secondsinteger-
automatic_taggingboolean-
autotracking_enabledboolean-
beginningOfWeekintegerwill be omitted if empty
calendar_snap_durationstring-
calendar_snap_initial_locationstring-
calendar_visible_hours_endinteger-
calendar_visible_hours_startinteger-
calendar_zoom_levelstring-
cell_swipe_actions_enabledboolean-
charts_view_typestring-
collapseDetailedReportEntriesbooleanwill be omitted if empty
collapseTimeEntriesbooleanwill be omitted if empty
dashboards_view_typestring-
date_formatstring-
decimal_separatorstringwill be omitted if empty
default_project_idinteger-
default_task_idinteger-
displayDensitystringwill be omitted if empty
distinctRatesstringwill be omitted if empty
duration_formatstring-
duration_format_on_timer_duration_fieldboolean-
edit_popup_integration_timerboolean-
extension_send_error_reportsboolean-
extension_send_usage_statisticsboolean-
firstSeenBusinessPromointegerwill be omitted if empty
focus_app_on_time_entry_startedboolean-
focus_app_on_time_entry_stoppedboolean-
haptic_feedback_enabledboolean-
hide_keyboard_shortcutbooleanwill be omitted if empty
idle_detection_enabledboolean-
idle_detection_interval_in_minutesinteger-
inactivity_behaviorstring-
ios_is_goals_view_shownboolean-
is_goals_view_expandedboolean-
is_goals_view_shownboolean-
is_summary_total_view_visibleboolean-
keep_mini_timer_on_topboolean-
keep_window_on_topboolean-
keyboard_increment_timer_pageinteger-
keyboard_shortcuts_enabledbooleanwill be omitted if empty
keyboard_shortcuts_share_time_entriesboolean-
mac_is_goals_view_shownboolean-
macos_auto_tracking_rulesArray of object-
macos_show_hide_toggl_keyboard_shortcutobject-
macos_stop_continue_keyboard_shortcutobject-
manualEntryModestringwill be omitted if empty
manualModebooleanwill be omitted if empty
manualModeOverlaySeenbooleanwill be omitted if empty
modify_on_start_time_changestring-
offlineModestringwill be omitted if empty
pg_time_zone_namestring-
pomodoro_auto_start_breakboolean-
pomodoro_auto_start_focusboolean-
pomodoro_break_interval_in_minutesinteger-
pomodoro_break_project_idinteger-
pomodoro_break_start_sound_enabledboolean-
pomodoro_break_tag_idinteger-
pomodoro_countdown_timerboolean-
pomodoro_enabledboolean-
pomodoro_focus_interval_in_minutesinteger-
pomodoro_focus_soundstring-
pomodoro_global_sound_enabledboolean-
pomodoro_interval_end_soundboolean-
pomodoro_interval_end_volumeinteger-
pomodoro_longer_break_duration_in_minutesinteger-
pomodoro_prevent_screen_lockboolean-
pomodoro_rounds_before_longer_breakinteger-
pomodoro_session_start_sound_enabledboolean-
pomodoro_show_notificationsboolean-
pomodoro_stop_timer_at_interval_endboolean-
pomodoro_track_breaks_as_time_entriesboolean-
projectDashboardActivityModestringwill be omitted if empty
project_shortcut_enabledboolean-
record_timelineboolean-
remember_last_projectstring-
reminder_daysstring-
reminder_enabledboolean-
reminder_interval_in_minutesinteger-
reminder_periodstring-
reminder_snoozing_in_minutesinteger-
reportRoundingbooleanwill be omitted if empty
reportRoundingDirectionstringwill be omitted if empty
reportRoundingStepInMinutesintegerwill be omitted if empty
reportsHideWeekendsbooleanwill be omitted if empty
run_app_on_startupboolean-
running_entry_warningstring-
running_timer_notification_enabledboolean-
seenFollowModalbooleanwill be omitted if empty
seenFooterPopupbooleanwill be omitted if empty
seenProjectDashboardOverlaybooleanwill be omitted if empty
seenTogglButtonModalbooleanwill be omitted if empty
send_daily_project_invitesboolean-
send_product_emailsboolean-
send_timer_notificationsboolean-
send_weekly_reportboolean-
sharing_shortcut_enabledboolean-
showTimeInTitlebooleanwill be omitted if empty
show_all_entriesboolean-
show_changelogboolean-
show_description_in_menu_barboolean-
show_dock_iconboolean-
show_events_in_calendarboolean-
show_project_in_menu_barboolean-
show_qr_scannerboolean-
show_seconds_in_menu_barboolean-
show_timeline_in_day_viewbooleanwill be omitted if empty
show_timer_in_menu_barboolean-
show_today_total_in_menu_barboolean-
show_total_billable_hoursbooleanwill be omitted if empty
show_weekend_on_timer_pagebooleanwill be omitted if empty
show_workouts_in_calendarboolean-
sleep_behaviourstring-
smart_alerts_optionstring-
snowballReportRoundingstringwill be omitted if empty
stack_times_on_manual_mode_afterstring-
start_automaticallyboolean-
start_shortcut_modestring-
stop_at_specific_timeboolean-
stop_automaticallyboolean-
stop_entry_on_shutdownboolean-
stop_specified_timestring-
stopped_timer_notification_enabledboolean-
suggestions_enabledboolean-
summaryReportAmountsstringwill be omitted if empty
summaryReportDistinctRatesbooleanwill be omitted if empty
summaryReportGroupingstringwill be omitted if empty
summaryReportSortAscbooleanwill be omitted if empty
summaryReportSortFieldstringwill be omitted if empty
summaryReportSubGroupingstringwill be omitted if empty
summary_total_modestring-
tags_shortcut_enabledboolean-
themestringwill be omitted if empty
time_entry_display_modestring-
time_entry_ghost_suggestions_enabledboolean-
time_entry_invitations_notification_enabledboolean-
time_entry_start_stop_input_modestring-
timeofday_formatstring-
timerViewstringwill be omitted if empty
timerViewMobilestringwill be omitted if empty
toSAcceptNeededbooleanToSAcceptNeeded represents the trigger for new ToS accept dialog
use_mini_timerboolean-
visibleFooterstringwill be omitted if empty
webTimeEntryStartedbooleanwill be omitted if empty
webTimeEntryStoppedbooleanwill be omitted if empty
weeklyReportGroupingstringwill be omitted if empty
weeklyReportValueToShowstringwill be omitted if empty
windows_auto_tracking_rulesArray of object-
windows_show_hide_toggl_keyboard_shortcutobject-
windows_stop_continue_keyboard_shortcutobject-
windows_stop_start_keyboard_shortcutobject-
windows_themestring-
workout_default_project_idinteger-
workout_default_tag_idinteger-
alpha_features
NameTypeDescription
alpha_feature_idintegerFeature ID
codestringFeature code
deleted_atstringTime of deletion, omitted if empty
descriptionstringFeature description, omitted if empty
enabledbooleanWhether the feature is enabled
macos_auto_tracking_rules
NameTypeDescription
idstring-
keywordstring-
project_idinteger-
task_idinteger-
macos_show_hide_toggl_keyboard_shortcut
NameTypeDescription
keyinteger-
modifiersinteger-
macos_stop_continue_keyboard_shortcut
NameTypeDescription
keyinteger-
modifiersinteger-
windows_auto_tracking_rules
NameTypeDescription
billableboolean-
descriptionstring-
enabledboolean-
idstring-
parametersobject-
project_idinteger-
skip_when_timer_is_runningboolean-
start_without_confirmationboolean-
tag_idsArray of integer-
task_idinteger-
typeinteger-
parameters
NameTypeDescription
durationstring-
keywordstring-
keyword_modestring-
time_of_daystring-
week_daysstring-
windows_show_hide_toggl_keyboard_shortcut
NameTypeDescription
keyinteger-
modifiersinteger-
windows_stop_continue_keyboard_shortcut
NameTypeDescription
keyinteger-
modifiersinteger-
windows_stop_start_keyboard_shortcut
NameTypeDescription
keyinteger-
modifiersinteger-

400

Unknown client.

403

User does not have access to this resource.

500

Internal Server Error

POST Update the preferences for an specific client of the current user

https://api.track.toggl.com/api/v9/me/preferences/{client}

With this endpoint, preferences can be modified and alpha features can be enabled or disabled.

curl -X POST https://api.track.toggl.com/api/v9/me/preferences/{client} \
-H "Content-Type: application/json" \
-d '\{"activity_timeline_display_activity":"boolean","activity_timeline_grouping_interval":"string","activity_timeline_grouping_method":"string","activity_timeline_recording_level":"string","activity_timeline_sync_events":"boolean","alpha_features":[\{"alpha_feature_id":"integer","code":"string","deleted_at":"string","description":"string","enabled":"boolean"\}],"analyticsAdvancedFilters":"boolean","auto_tracker_delay_enabled":"boolean","auto_tracker_delay_in_seconds":"integer","automatic_tagging":"boolean","autotracking_enabled":"boolean","beginningOfWeek":"integer","calendar_snap_duration":"string","calendar_snap_initial_location":"string","calendar_visible_hours_end":"integer","calendar_visible_hours_start":"integer","calendar_zoom_level":"string","cell_swipe_actions_enabled":"boolean","charts_view_type":"string","collapseDetailedReportEntries":"boolean","collapseTimeEntries":"boolean","dashboards_view_type":"string","date_format":"string","decimal_separator":"string","default_project_id":"integer","default_task_id":"integer","displayDensity":"string","distinctRates":"string","duration_format":"string","duration_format_on_timer_duration_field":"boolean","edit_popup_integration_timer":"boolean","extension_send_error_reports":"boolean","extension_send_usage_statistics":"boolean","firstSeenBusinessPromo":"integer","focus_app_on_time_entry_started":"boolean","focus_app_on_time_entry_stopped":"boolean","haptic_feedback_enabled":"boolean","hide_keyboard_shortcut":"boolean","idle_detection_enabled":"boolean","idle_detection_interval_in_minutes":"integer","inactivity_behavior":"string","ios_is_goals_view_shown":"boolean","is_goals_view_expanded":"boolean","is_goals_view_shown":"boolean","is_summary_total_view_visible":"boolean","keep_mini_timer_on_top":"boolean","keep_window_on_top":"boolean","keyboard_increment_timer_page":"integer","keyboard_shortcuts_enabled":"boolean","keyboard_shortcuts_share_time_entries":"boolean","mac_is_goals_view_shown":"boolean","macos_auto_tracking_rules":[\{"id":"string","keyword":"string","project_id":"integer","task_id":"integer"\}],"macos_show_hide_toggl_keyboard_shortcut":\{"key":"integer","modifiers":"integer"\},"macos_stop_continue_keyboard_shortcut":\{"key":"integer","modifiers":"integer"\},"manualEntryMode":"string","manualMode":"boolean","manualModeOverlaySeen":"boolean","modify_on_start_time_change":"string","offlineMode":"string","pg_time_zone_name":"string","pomodoro_auto_start_break":"boolean","pomodoro_auto_start_focus":"boolean","pomodoro_break_interval_in_minutes":"integer","pomodoro_break_project_id":"integer","pomodoro_break_start_sound_enabled":"boolean","pomodoro_break_tag_id":"integer","pomodoro_countdown_timer":"boolean","pomodoro_enabled":"boolean","pomodoro_focus_interval_in_minutes":"integer","pomodoro_focus_sound":"string","pomodoro_global_sound_enabled":"boolean","pomodoro_interval_end_sound":"boolean","pomodoro_interval_end_volume":"integer","pomodoro_longer_break_duration_in_minutes":"integer","pomodoro_prevent_screen_lock":"boolean","pomodoro_rounds_before_longer_break":"integer","pomodoro_session_start_sound_enabled":"boolean","pomodoro_show_notifications":"boolean","pomodoro_stop_timer_at_interval_end":"boolean","pomodoro_track_breaks_as_time_entries":"boolean","projectDashboardActivityMode":"string","project_shortcut_enabled":"boolean","record_timeline":"boolean","remember_last_project":"string","reminder_days":"string","reminder_enabled":"boolean","reminder_interval_in_minutes":"integer","reminder_period":"string","reminder_snoozing_in_minutes":"integer","reportRounding":"boolean","reportRoundingDirection":"string","reportRoundingStepInMinutes":"integer","reportsHideWeekends":"boolean","run_app_on_startup":"boolean","running_entry_warning":"string","running_timer_notification_enabled":"boolean","seenFollowModal":"boolean","seenFooterPopup":"boolean","seenProjectDashboardOverlay":"boolean","seenTogglButtonModal":"boolean","send_daily_project_invites":"boolean","send_product_emails":"boolean","send_timer_notifications":"boolean","send_weekly_report":"boolean","sharing_shortcut_enabled":"boolean","showTimeInTitle":"boolean","show_all_entries":"boolean","show_changelog":"boolean","show_description_in_menu_bar":"boolean","show_dock_icon":"boolean","show_events_in_calendar":"boolean","show_project_in_menu_bar":"boolean","show_qr_scanner":"boolean","show_seconds_in_menu_bar":"boolean","show_timeline_in_day_view":"boolean","show_timer_in_menu_bar":"boolean","show_today_total_in_menu_bar":"boolean","show_total_billable_hours":"boolean","show_weekend_on_timer_page":"boolean","show_workouts_in_calendar":"boolean","sleep_behaviour":"string","smart_alerts_option":"string","snowballReportRounding":"string","stack_times_on_manual_mode_after":"string","start_automatically":"boolean","start_shortcut_mode":"string","stop_at_specific_time":"boolean","stop_automatically":"boolean","stop_entry_on_shutdown":"boolean","stop_specified_time":"string","stopped_timer_notification_enabled":"boolean","suggestions_enabled":"boolean","summaryReportAmounts":"string","summaryReportDistinctRates":"boolean","summaryReportGrouping":"string","summaryReportSortAsc":"boolean","summaryReportSortField":"string","summaryReportSubGrouping":"string","summary_total_mode":"string","tags_shortcut_enabled":"boolean","theme":"string","time_entry_display_mode":"string","time_entry_ghost_suggestions_enabled":"boolean","time_entry_invitations_notification_enabled":"boolean","time_entry_start_stop_input_mode":"string","timeofday_format":"string","timerView":"string","timerViewMobile":"string","toSAcceptNeeded":"boolean","use_mini_timer":"boolean","visibleFooter":"string","webTimeEntryStarted":"boolean","webTimeEntryStopped":"boolean","weeklyReportGrouping":"string","weeklyReportValueToShow":"string","windows_auto_tracking_rules":[\{"billable":"boolean","description":"string","enabled":"boolean","id":"string","parameters":\{"duration":"string","keyword":"string","keyword_mode":"string","time_of_day":"string","week_days":"string"\},"project_id":"integer","skip_when_timer_is_running":"boolean","start_without_confirmation":"boolean","tag_ids":[\{\}],"task_id":"integer","type":"integer"\}],"windows_show_hide_toggl_keyboard_shortcut":\{"key":"integer","modifiers":"integer"\},"windows_stop_continue_keyboard_shortcut":\{"key":"integer","modifiers":"integer"\},"windows_stop_start_keyboard_shortcut":\{"key":"integer","modifiers":"integer"\},"windows_theme":"string","workout_default_project_id":"integer","workout_default_tag_id":"integer"\}' \
-u <email>:<password>

Parameters

Path

nametyperequireddescription
clientstringfalseClient type

Body

NameTypeDescription
activity_timeline_display_activityboolean-
activity_timeline_grouping_intervalstring-
activity_timeline_grouping_methodstring-
activity_timeline_recording_levelstring-
activity_timeline_sync_eventsboolean-
alpha_featuresArray of objectwill be omitted if empty
analyticsAdvancedFiltersbooleanwill be omitted if empty
auto_tracker_delay_enabledboolean-
auto_tracker_delay_in_secondsinteger-
automatic_taggingboolean-
autotracking_enabledboolean-
beginningOfWeekintegerwill be omitted if empty
calendar_snap_durationstring-
calendar_snap_initial_locationstring-
calendar_visible_hours_endinteger-
calendar_visible_hours_startinteger-
calendar_zoom_levelstring-
cell_swipe_actions_enabledboolean-
charts_view_typestring-
collapseDetailedReportEntriesbooleanwill be omitted if empty
collapseTimeEntriesbooleanwill be omitted if empty
dashboards_view_typestring-
date_formatstring-
decimal_separatorstringwill be omitted if empty
default_project_idinteger-
default_task_idinteger-
displayDensitystringwill be omitted if empty
distinctRatesstringwill be omitted if empty
duration_formatstring-
duration_format_on_timer_duration_fieldboolean-
edit_popup_integration_timerboolean-
extension_send_error_reportsboolean-
extension_send_usage_statisticsboolean-
firstSeenBusinessPromointegerwill be omitted if empty
focus_app_on_time_entry_startedboolean-
focus_app_on_time_entry_stoppedboolean-
haptic_feedback_enabledboolean-
hide_keyboard_shortcutbooleanwill be omitted if empty
idle_detection_enabledboolean-
idle_detection_interval_in_minutesinteger-
inactivity_behaviorstring-
ios_is_goals_view_shownboolean-
is_goals_view_expandedboolean-
is_goals_view_shownboolean-
is_summary_total_view_visibleboolean-
keep_mini_timer_on_topboolean-
keep_window_on_topboolean-
keyboard_increment_timer_pageinteger-
keyboard_shortcuts_enabledbooleanwill be omitted if empty
keyboard_shortcuts_share_time_entriesboolean-
mac_is_goals_view_shownboolean-
macos_auto_tracking_rulesArray of object-
macos_show_hide_toggl_keyboard_shortcutobject-
macos_stop_continue_keyboard_shortcutobject-
manualEntryModestringwill be omitted if empty
manualModebooleanwill be omitted if empty
manualModeOverlaySeenbooleanwill be omitted if empty
modify_on_start_time_changestring-
offlineModestringwill be omitted if empty
pg_time_zone_namestring-
pomodoro_auto_start_breakboolean-
pomodoro_auto_start_focusboolean-
pomodoro_break_interval_in_minutesinteger-
pomodoro_break_project_idinteger-
pomodoro_break_start_sound_enabledboolean-
pomodoro_break_tag_idinteger-
pomodoro_countdown_timerboolean-
pomodoro_enabledboolean-
pomodoro_focus_interval_in_minutesinteger-
pomodoro_focus_soundstring-
pomodoro_global_sound_enabledboolean-
pomodoro_interval_end_soundboolean-
pomodoro_interval_end_volumeinteger-
pomodoro_longer_break_duration_in_minutesinteger-
pomodoro_prevent_screen_lockboolean-
pomodoro_rounds_before_longer_breakinteger-
pomodoro_session_start_sound_enabledboolean-
pomodoro_show_notificationsboolean-
pomodoro_stop_timer_at_interval_endboolean-
pomodoro_track_breaks_as_time_entriesboolean-
projectDashboardActivityModestringwill be omitted if empty
project_shortcut_enabledboolean-
record_timelineboolean-
remember_last_projectstring-
reminder_daysstring-
reminder_enabledboolean-
reminder_interval_in_minutesinteger-
reminder_periodstring-
reminder_snoozing_in_minutesinteger-
reportRoundingbooleanwill be omitted if empty
reportRoundingDirectionstringwill be omitted if empty
reportRoundingStepInMinutesintegerwill be omitted if empty
reportsHideWeekendsbooleanwill be omitted if empty
run_app_on_startupboolean-
running_entry_warningstring-
running_timer_notification_enabledboolean-
seenFollowModalbooleanwill be omitted if empty
seenFooterPopupbooleanwill be omitted if empty
seenProjectDashboardOverlaybooleanwill be omitted if empty
seenTogglButtonModalbooleanwill be omitted if empty
send_daily_project_invitesboolean-
send_product_emailsboolean-
send_timer_notificationsboolean-
send_weekly_reportboolean-
sharing_shortcut_enabledboolean-
showTimeInTitlebooleanwill be omitted if empty
show_all_entriesboolean-
show_changelogboolean-
show_description_in_menu_barboolean-
show_dock_iconboolean-
show_events_in_calendarboolean-
show_project_in_menu_barboolean-
show_qr_scannerboolean-
show_seconds_in_menu_barboolean-
show_timeline_in_day_viewbooleanwill be omitted if empty
show_timer_in_menu_barboolean-
show_today_total_in_menu_barboolean-
show_total_billable_hoursbooleanwill be omitted if empty
show_weekend_on_timer_pagebooleanwill be omitted if empty
show_workouts_in_calendarboolean-
sleep_behaviourstring-
smart_alerts_optionstring-
snowballReportRoundingstringwill be omitted if empty
stack_times_on_manual_mode_afterstring-
start_automaticallyboolean-
start_shortcut_modestring-
stop_at_specific_timeboolean-
stop_automaticallyboolean-
stop_entry_on_shutdownboolean-
stop_specified_timestring-
stopped_timer_notification_enabledboolean-
suggestions_enabledboolean-
summaryReportAmountsstringwill be omitted if empty
summaryReportDistinctRatesbooleanwill be omitted if empty
summaryReportGroupingstringwill be omitted if empty
summaryReportSortAscbooleanwill be omitted if empty
summaryReportSortFieldstringwill be omitted if empty
summaryReportSubGroupingstringwill be omitted if empty
summary_total_modestring-
tags_shortcut_enabledboolean-
themestringwill be omitted if empty
time_entry_display_modestring-
time_entry_ghost_suggestions_enabledboolean-
time_entry_invitations_notification_enabledboolean-
time_entry_start_stop_input_modestring-
timeofday_formatstring-
timerViewstringwill be omitted if empty
timerViewMobilestringwill be omitted if empty
toSAcceptNeededbooleanToSAcceptNeeded represents the trigger for new ToS accept dialog
use_mini_timerboolean-
visibleFooterstringwill be omitted if empty
webTimeEntryStartedbooleanwill be omitted if empty
webTimeEntryStoppedbooleanwill be omitted if empty
weeklyReportGroupingstringwill be omitted if empty
weeklyReportValueToShowstringwill be omitted if empty
windows_auto_tracking_rulesArray of object-
windows_show_hide_toggl_keyboard_shortcutobject-
windows_stop_continue_keyboard_shortcutobject-
windows_stop_start_keyboard_shortcutobject-
windows_themestring-
workout_default_project_idinteger-
workout_default_tag_idinteger-
alpha_features
NameTypeDescription
alpha_feature_idintegerFeature ID
codestringFeature code
deleted_atstringTime of deletion, omitted if empty
descriptionstringFeature description, omitted if empty
enabledbooleanWhether the feature is enabled
macos_auto_tracking_rules
NameTypeDescription
idstring-
keywordstring-
project_idinteger-
task_idinteger-
macos_show_hide_toggl_keyboard_shortcut
NameTypeDescription
keyinteger-
modifiersinteger-
macos_stop_continue_keyboard_shortcut
NameTypeDescription
keyinteger-
modifiersinteger-
windows_auto_tracking_rules
NameTypeDescription
billableboolean-
descriptionstring-
enabledboolean-
idstring-
parametersobject-
project_idinteger-
skip_when_timer_is_runningboolean-
start_without_confirmationboolean-
tag_idsArray of integer-
task_idinteger-
typeinteger-
parameters
NameTypeDescription
durationstring-
keywordstring-
keyword_modestring-
time_of_daystring-
week_daysstring-
windows_show_hide_toggl_keyboard_shortcut
NameTypeDescription
keyinteger-
modifiersinteger-
windows_stop_continue_keyboard_shortcut
NameTypeDescription
keyinteger-
modifiersinteger-
windows_stop_start_keyboard_shortcut
NameTypeDescription
keyinteger-
modifiersinteger-

Response

200

Successful operation.

400

Possible error messages:

  • Cannot set value for ToSAcceptNeeded
  • Invalid feature code(s)
  • Missing data
  • Unknown client
  • Value in date_format is invalid
  • Value in timeofday_format is invalid

403

User does not have access to this resource.

500

Internal Server Error

GET Get workspace preferences

https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/preferences

Get the preferences for a given workspace.

curl  https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/preferences \
-H "Content-Type: application/json" \
-u <email>:<password>

Parameters

Path

nametyperequireddescription
workspace_idintegertrueNumeric ID of the workspace

Response

200

NameTypeDescription
logostring-

400

Workspace not found

403

User does not have access to this resource.

500

Internal Server Error

POST Update workspace preferences

https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/preferences

Update the preferences for a given workspace.

curl -X POST https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/preferences \
-H "Content-Type: application/json" \
-d '\{"hide_start_end_times":"boolean","inc_tos_accepted_at":"string","inc_tos_accepted_by":"integer","initial_pricing_plan":"integer","report_locked_at":"string","single_sign_on":"boolean","sso_requested_at":"string"\}' \
-u <email>:<password>

Parameters

Path

nametyperequireddescription
workspace_idintegertrueNumeric ID of the workspace

Body

NameTypeDescription
hide_start_end_timesbooleanThis workspace works with duration only time entries
inc_tos_accepted_atstringTime of acceptance of the terms of service
inc_tos_accepted_byintegerUser ID who accepted the terms of service
initial_pricing_planintegerPricing plan ID
report_locked_atstringDate on which "Lock Time Entries" feature was enabled
single_sign_onbooleanWhether SSO is enabled for this workspace
sso_requested_atstringDate on which SSO was requested

Response

200

NameTypeDescription
logostring-

400

Possi