Skip to main content

Me

GET Me

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

Returns details for the current user.

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

Response

200

nametypedescription
api_tokenstringwill be omitted if empty
atstring-
beginning_of_weekinteger-
country_idinteger-
created_atstring-
default_workspace_idinteger-
emailstring-
fullnamestring-
idinteger-
image_urlstring-
intercom_hashstringwill be omitted if empty
openid_emailstring-
openid_enabledboolean-
options
nametypedescription
additionalPropertiesobject-
will be omitted if empty
timezonestring-
updated_atstring-

403

User does not have access to this resource.

404

could not load user data

500

Internal Server Error

PUT Me

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

Updates details for the current user.

curl -X PUT https://api.track.toggl.com/api/v9/me \
-H "Content-Type: application/json" \
-d '{"beginning_of_week":"integer","country_id":"integer","current_password":"string","default_workspace_id":"integer","email":"string","fullname":"string","password":"string","timezone":"string"}' \
-u <email>:<password>

Parameters

Body

nametypedescription
beginning_of_weekintegerUser's first day of the week. Sunday: 0, Monday:1, etc.
country_idintegerUser's country ID
current_passwordstringUser's current password (used to change the current password)
default_workspace_idintegerUser's default workspace ID
emailstringUser's email address
fullnamestringUser's full name
passwordstringUser's new password (current one must also be provided)
timezonestringUser's timezone

Response

200

nametypedescription
api_tokenstringwill be omitted if empty
atstring-
beginning_of_weekinteger-
country_idinteger-
created_atstring-
default_workspace_idinteger-
emailstring-
fullnamestring-
idinteger-
image_urlstring-
openid_emailstring-
openid_enabledboolean-
options
nametypedescription
additionalPropertiesobject-
will be omitted if empty
timezonestring-
updated_atstring-

400

Possible error messages:

* Current password is not valid
* Current password must be present to change password
* Invalid beginning_of_week
* Invalid country_id
* Invalid default_workspace_id
* Invalid email
* Invalid fullname
* Invalid timezone
* Password should be at least 6 characters
* user with this email already exists

403

User does not have access to this resource.

GET Clients

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

Get Clients.

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

Parameters

Query

nametyperequireddescription
sinceintegerfalseRetrieve clients created/modified/deleted since this date using UNIX timestamp.

Response

200

Array of:

nametypedescription
archivedboolean-
atstring-
idinteger-
namestring-
server_deleted_atstring-
widinteger-

500

Internal Server Error

POST CloseAccount

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

Close Account

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

Response

200

Successful operation.

500

Internal Server Error

GET Features

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

Get features.

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

Response

200

Array of:

nametypedescription
featuresArray of
nametypedescription
enabledboolean-
feature_idinteger-
namestring-
-
workspace_idinteger-

403

Operation Forbidden

500

Internal Server Error

GET User's last known location

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

Returns the client's IP-based location. If no data is present, empty response will be yielded.

curl  https://api.track.toggl.com/api/v9/me/location \
-H "Content-Type: application/json"

Response

200

nametypedescription
citystring-
city_lat_longstring-
country_codestring-
country_namestring-
statestring-

404

Country with given ISO code not found

500

Internal Server Error

GET Logged

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

Used to check if authentication works.

curl  https://api.track.toggl.com/api/v9/me/logged \
-H "Content-Type: application/json"

Response

200

500

Internal Server Error

GET LostPassword

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

Verifies the user request to reset the password.

curl  https://api.track.toggl.com/api/v9/me/lost_passwords \
-H "Content-Type: application/json"

Response

200

Successful operation

500

Internal Server Error

POST LostPassword

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

Handles the users request to reset the password.

curl -X POST https://api.track.toggl.com/api/v9/me/lost_passwords \
-H "Content-Type: application/json" \
-d '{"email":"string"}'

Parameters

Body

nametypedescription
emailstringEmail of user requesting password reset

Response

200

Successful operation

500

Internal Server Error

POST LostPassword conformation

https://api.track.toggl.com/api/v9/me/lost_passwords/confirm

Handles lost password request confirmation.

curl -X POST https://api.track.toggl.com/api/v9/me/lost_passwords/confirm \
-H "Content-Type: application/json" \
-d '{"code":"string","password":"string","user_id":"integer"}'

Parameters

Body

nametypedescription
codestringTemporary token to reset password
passwordstringUser's new password
user_idintegerUser's ID

Response

200

Successful operation

500

Internal Server Error

GET Organizations that a user is part of

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

Get all organizations a given user is part of.

curl  https://api.track.toggl.com/api/v9/me/organizations \
-H "Content-Type: application/json"

Response

200

Array of:

nametypedescription
adminbooleanWhether the requester is an admin of the organization
atstringOrganization's last modification date
created_atstringOrganization's creation date
idintegerOrganization ID
is_chargifyboolean-
is_multi_workspace_enabledbooleanIs true when the organization option is_multi_workspace_enabled is set
is_unifiedboolean-
max_workspacesintegerMaximum number of workspaces allowed for the organization
namestringOrganization Name
ownerbooleanWhether the requester is a the owner of the organization
payment_methodsstringOrganization's subscription payment methods. Omitted if empty.
pricing_plan_idintegerOrganization plan ID
server_deleted_atstring | nullOrganization's delete date
suspended_atstringWhether the organization is currently suspended
trial_info
nametypedescription
last_pricing_plan_idinteger | nullWhat was the previous plan before the trial
next_payment_datestring | nullWhen the trial payment is due
trialbooleanWhether the organization's subscription is currently on trial
trial_availablebooleanWhen a trial is available for this organization
trial_end_datestring | nullWhen the trial ends
-
user_countintegerNumber of organization users

500

Internal Server Error

GET Projects

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

Get projects

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

Parameters

Query

nametyperequireddescription
include_archivedstringfalseInclude archived projects.
sinceintegerfalseRetrieve projects modified since this date using UNIX timestamp, including deleted ones.

Response

200

Array of:

nametypedescription
activebooleanWhether the project is active or archived
actual_hoursinteger | nullActual hours
atstringLast updated date
auto_estimatesboolean | nullWhether estimates are based on task hours, premium feature
billableboolean | nullWhether the project is billable, premium feature
cidintegerClient ID legacy field
client_idinteger | nullClient ID
colorstringColor
created_atstringCreation date
currencystring | nullCurrency, premium feature
current_period
nametypedescription
end_datestring-
start_datestring-
Current project period, premium feature
end_datestringEnd date
estimated_hoursinteger | nullEstimated hours
first_time_entrystringFirst time entry for this project. Only included if it was requested with with_first_time_entry
fixed_feenumberFixed fee, premium feature
idintegerProject ID
is_privatebooleanWhether the project is private
namestringName
ratenumberHourly rate
rate_last_updatedstring | nullLast date for rate change
recurringbooleanWhether the project is recurring, premium feature
recurring_parametersArray of
nametypedescription
custom_periodintegerCustom period, used when "period" field is "custom"
estimated_secondsintegerEstimated seconds
parameter_end_datestring | nullRecurring end date
parameter_start_datestringRecurring start date
periodstringPeriod
project_start_datestringProject start date
Project recurring parameters, premium feature
server_deleted_atstring | nullDeletion date
start_datestringStart date
templateboolean | nullWhether the project is used as template, premium feature
widintegerWorkspace ID legacy field
workspace_idintegerWorkspace ID

400

Invalid include_archived

403

Operation Forbidden

500

Internal Server Error

GET ProjectsPaginated

https://api.track.toggl.com/api/v9/me/projects/paginated

Get paginated projects.

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

Parameters

Query

nametyperequireddescription
start_project_idintegerfalseProject ID to resume the next pagination from.
sinceintegerfalseRetrieve projects created/modified/deleted since this date using UNIX timestamp.
per_pageintegerfalseNumber of records per page.

Response

200

Array of:

nametypedescription
activebooleanWhether the project is active or archived
actual_hoursinteger | nullActual hours
atstringLast updated date
auto_estimatesboolean | nullWhether estimates are based on task hours, premium feature
billableboolean | nullWhether the project is billable, premium feature
cidintegerClient ID legacy field
client_idinteger | nullClient ID
colorstringColor
created_atstringCreation date
currencystring | nullCurrency, premium feature
current_period
nametypedescription
end_datestring-
start_datestring-
Current project period, premium feature
end_datestringEnd date
estimated_hoursinteger | nullEstimated hours
first_time_entrystringFirst time entry for this project. Only included if it was requested with with_first_time_entry
fixed_feenumberFixed fee, premium feature
idintegerProject ID
is_privatebooleanWhether the project is private
namestringName
ratenumberHourly rate
rate_last_updatedstring | nullLast date for rate change
recurringbooleanWhether the project is recurring, premium feature
recurring_parametersArray of
nametypedescription
custom_periodintegerCustom period, used when "period" field is "custom"
estimated_secondsintegerEstimated seconds
parameter_end_datestring | nullRecurring end date
parameter_start_datestringRecurring start date
periodstringPeriod
project_start_datestringProject start date
Project recurring parameters, premium feature
server_deleted_atstring | nullDeletion date
start_datestringStart date
templateboolean | nullWhether the project is used as template, premium feature
widintegerWorkspace ID legacy field
workspace_idintegerWorkspace ID

403

Operation Forbidden

500

Internal Server Error

GET Tags

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

Returns tags for the current user.

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

Parameters

Query

nametyperequireddescription
sinceintegerfalseRetrieve tags modified/deleted since this date using UNIX timestamp.

Response

200

Array of:

nametypedescription
atstringWhen was created/last modified
deleted_atstringWhen was deleted
idintegerTag ID
namestringTag name
workspace_idintegerWorkspace ID

403

User does not have access to this resource.

500

Internal Server Error

GET Tasks

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

Returns tasks from projects in which the user is participating.

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

Parameters

Query

nametyperequireddescription
sinceintegerfalseRetrieve tasks created/modified/deleted since this date using UNIX timestamp.
include_not_activestringfalseInclude tasks marked as done.

Response

200

Array of:

nametypedescription
activebooleanFalse when the task has been done
atstringWhen the task was created/last modified
estimated_secondsinteger | nullEstimation time for this task in seconds
idintegerTask ID
namestringTask Name
project_idintegerProject ID
recurringbooleanWhether this is a recurring task
server_deleted_atstring | nullWhen the task was deleted
tracked_secondsintegerThe value tracked_seconds is in milliseconds, not in seconds.
user_idinteger | nullTask assignee, if available
workspace_idintegerWorkspace ID

400

Invalid include_not_active

403

User does not have access to this resource.

500

Internal Server Error

GET TrackReminders

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

Returns a list of track reminders.

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

Response

200

Returns a list of track reminders.

Array of:

nametypedescription
created_atstringReminder creation time
frequencyintegerFrequency of the reminder in days, should be either 1 or 7
group_idsArray of integerGroups IDs to send the reminder to
reminder_idintegerReminder ID
thresholdintegerThreshold is the number of hours after which the reminder will be sent
user_idsArray of integerUser IDs to send the reminder to
workspace_idintegerWorkspace ID

403

User does not have access to this resource.

500

Internal Server Error

GET WebTimer

https://api.track.toggl.com/api/v9/me/web-timer

Get web timer.

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

Response

200

Successful operation

403

Operation Forbidden

404

Resource can not be found

500

Internal Server Error

GET Workspaces

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

Lists workspaces for given user.

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

Parameters

Query

nametyperequireddescription
sinceintegerfalseRetrieve workspaces created/modified/deleted since this date using UNIX timestamp, including the dates a workspace member got added, removed or updated in the workspace.

Response

200

Array of:

nametypedescription
adminboolean-
api_tokenstring-
atstring-
business_wsboolean-
csv_upload
nametypedescription
atstring-
log_idinteger-
-
default_currencystring-
default_hourly_ratenumber-
ical_enabledboolean-
ical_urlstring-
idinteger-
logo_urlstring-
namestring-
only_admins_may_create_projectsboolean-
only_admins_may_create_tagsboolean-
only_admins_see_billable_ratesboolean-
only_admins_see_team_dashboardboolean-
organization_idinteger-
premiumboolean-
profileinteger-
projects_billable_by_defaultboolean-
rate_last_updatedstring-
reports_collapseboolean-
roundinginteger-
rounding_minutesinteger-
server_deleted_atstring-
subscription
nametypedescription
auto_renewboolean-
card_detailsmodels.CardDetails-
company_idinteger-
contact_detailmodels.ContactDetail-
created_atstring-
currencystring-
customer_idinteger-
deleted_atstring-
last_pricing_plan_idinteger-
organization_idinteger-
payment_detailsmodels.PaymentDetail-
pricing_plan_idinteger-
renewal_atstring-
subscription_idinteger-
subscription_periodmodels.Period-
workspace_idinteger-
-
suspended_atstring-
te_constraints
nametypedescription
description_presentboolean-
project_presentboolean-
tag_presentboolean-
task_presentboolean-
time_entry_constraints_enabledboolean-
-

403

User does not have access to this resource.

500

Internal Server Error
© 2023 Toggl. All rights reserved.