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>

Parameters

Query

nametyperequireddescription
with_related_databooleanfalseRetrieve user related data (clients, projects, tasks, tags, workspaces, time entries, etc.)

Response

200

nametypedescription
api_tokenstringwill be omitted if empty
atstring-
authorization_updated_atstringAuthorizationUpdatedAt timestamp when the authorization user session object was last updated.
beginning_of_weekinteger-
clientsArray of
nametypedescription
archivedbooleanIsArchived is true if the client is archived
atstringWhen was the last update
creator_idintegerCreatorID is the ID of the user who created the client
idintegerClient ID
integration_providerstringIntegrations data
namestringName of the client
notesstring-
permissionsstringList of authorization permissions for this client.
widintegerWorkspace ID
Clients, null if with_related_data was not set to true or if the user does not have any clients
country_idinteger-
created_atstring-
default_workspace_idinteger-
emailstring-
fullnamestring-
has_passwordboolean-
idinteger-
image_urlstring-
intercom_hashstringwill be omitted if empty
oauth_providersArray of string-
openid_emailstring-
openid_enabledboolean-
options
nametypedescription
additionalPropertiesobject-
will be omitted if empty
projectsArray of
nametypedescription
activebooleanWhether the project is active or archived
actual_hoursinteger | nullActual hours
actual_secondsinteger | nullActual seconds
atstringLast updated date
auto_estimatesboolean | nullWhether estimates are based on task hours, premium feature
billableboolean | nullWhether the project is billable, premium feature
can_track_timeboolean-
cidintegerClient ID legacy field
client_idinteger | nullClient ID
colorstringColor
created_atstringCreation date
currencystring | nullCurrency, premium feature
current_periodmodels.RecurringPeriodCurrent project period, premium feature
end_datestringEnd date
estimated_hoursinteger | nullEstimated hours
estimated_secondsinteger | nullEstimated seconds
fixed_feenumberFixed fee, premium feature
idintegerProject ID
integration_providerstringIntegrations data
is_privatebooleanWhether the project is private
is_sharedbooleanShared Project
namestringName
permissionsstring-
ratenumberHourly rate
rate_last_updatedstring | nullLast date for rate change
recurringbooleanWhether the project is recurring, premium feature
recurring_parametersArray of models.RecurringProjectParametersProject recurring parameters, premium feature
shared_atstring-
shared_hashstring-
start_datestringStart date
statusstringStatus of the project (upcoming, active, ended, archived, deleted)
templateboolean | nullWhether the project is used as template, premium feature
template_idinteger | nullTemplate ID
widintegerWorkspace ID legacy field
workspace_idintegerWorkspace ID
Projects, null if with_related_data was not set to true or if the user does not have any projects
tagsArray of
nametypedescription
atstringWhen was created/last modified
creator_idintegerCreatorID the user who created the tag
deleted_atstringWhen was deleted
idintegerTag ID
integration_providerstringIntegrations data
namestringTag name
permissionsstring-
workspace_idintegerWorkspace ID
Tags, null if with_related_data was not set to true, or if the user does not have any tags
tasksArray of
nametypedescription
activebooleanFalse when the task has been done
atstringWhen the task was created/last modified
client_namestring | null-
estimated_secondsinteger | nullEstimation time for this task in seconds
idintegerTask ID
integration_providerstringIntegrations data
namestringTask Name
permissionsstring-
project_colorstringMetadata
project_idintegerProject ID
project_namestring-
recurringbooleanWhether this is a recurring task
toggl_accounts_idstring | nullTask assignee, if set above this will be the toggl_account_id for that user
tracked_secondsintegerThe value tracked_seconds is in milliseconds, not in seconds.
user_idinteger | nullTask assignee, if available
workspace_idintegerWorkspace ID
Tasks, null if with_related_data was not set to true or if the user does not have any tasks
time_entriesArray of
nametypedescription
atstringWhen was last updated
billablebooleanWhether the time entry is marked as billable
client_namestringRelated entities meta fields - if requested
descriptionstring | nullTime Entry description, null if not provided at creation/update
durationintegerTime entry duration. For running entries should be negative, preferable -1
duronlybooleanUsed to create a TE with a duration but without a stop time, this field is deprecated for GET endpoints where the value will always be true.
idintegerTime Entry ID
permissionsArray of stringPermission list
pidintegerProject ID, legacy field
project_activeboolean-
project_colorstring-
project_idinteger | nullProject ID. Can be null if project was not provided or project was later deleted
project_namestring-
shared_withArray of models.TimeEntrySharedWithIndicates who the time entry has been shared with
startstringStart time in UTC
stopstringStop time in UTC, can be null if it's still running or created with "duration" and "duronly" fields
tag_idsArray of integerTag IDs, null if tags were not provided or were later deleted
tagsArray of stringTag names, null if tags were not provided or were later deleted
task_idinteger | nullTask ID. Can be null if task was not provided or project was later deleted
task_namestring-
tidintegerTask ID, legacy field
uidintegerTime Entry creator ID, legacy field
user_avatar_urlstring-
user_idintegerTime Entry creator ID
user_namestring-
widintegerWorkspace ID, legacy field
workspace_idintegerWorkspace ID
TimeEntries, null if with_related_data was not set to true or if the user does not have any time entries
timezonestring-
updated_atstring-
workspacesArray of
nametypedescription
adminbooleanCurrent user is workspace admin
api_tokenstringdeprecated
atstringTimestamp of last workspace change
business_wsbooleanWorkspace on Premium subscription
csv_uploadmodels.CsvUploadCSV upload data
default_currencystringDefault currency, premium feature, optional, only for existing WS, will be 'USD' initially
default_hourly_ratenumberThe default hourly rate, premium feature, optional, only for existing WS, will be 0.0 initially
hide_start_end_timesboolean-
ical_enabledbooleanCalendar integration enabled
ical_urlstringURL of calendar
idintegerIdentifier of the workspace
last_modifiedstringLast modification of data in the workspace
logo_urlstringURL of workspace logo
max_data_retention_daysintegerHow far back free workspaces can access data.
namestringName of the workspace
only_admins_may_create_projectsbooleanOnly admins will be able to create projects, optional, only for existing WS, will be false initially
only_admins_may_create_tagsbooleanOnly admins will be able to create tags, optional, only for existing WS, will be false initially
only_admins_see_billable_ratesbooleanWhether only admins will be able to see billable rates, premium feature, optional, only for existing WS. Will be false initially
only_admins_see_team_dashboardbooleanOnly admins will be able to see the team dashboard, optional, only for existing WS, will be false initially
organization_idintegerIdentifier of the organization
permissionsstringPermissions list
premiumbooleanWorkspace on Starter subscription
profileintegerdeprecated
projects_billable_by_defaultbooleanNew projects billable by default
projects_private_by_defaultbooleanWorkspace setting for default project visbility.
rate_last_updatedstringTimestamp of last workspace rate update
reports_collapsebooleanWhether reports should be collapsed by default, optional, only for existing WS, will be true initially
rolestringRole of the current user in the workspace
roundingintegerDefault rounding, premium feature, optional, only for existing WS. 0 - nearest, 1 - round up, -1 - round down
rounding_minutesintegerDefault rounding in minutes, premium feature, optional, only for existing WS
subscriptionmodels.Subscriptiondeprecated
suspended_atstringTimestamp of suspension
te_constraintsmodels.TimeEntryConstraintsTime entry constraints setting
working_hours_in_minutesintegerWorking hours in minutes
Workspaces, null if with_related_data was not set to true or if the user does not have any workspaces

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-
has_passwordboolean-
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
archivedbooleanIsArchived is true if the client is archived
atstringWhen was the last update
creator_idintegerCreatorID is the ID of the user who created the client
idintegerClient ID
integration_providerstringIntegrations data
namestringName of the client
notesstring-
permissionsstringList of authorization permissions for this client.
widintegerWorkspace ID

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

OK

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_multi_workspace_enabledbooleanIs true when the organization option is_multi_workspace_enabled is set
is_unifiedboolean-
max_data_retention_daysintegerHow far back free workspaces in this org can access data.
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.
permissionsstring-
pricing_plan_enterprisebooleanThe subscription plan is an enterprise plan
pricing_plan_idintegerOrganization plan ID
pricing_plan_namestringThe subscription plan name the org is currently on. Free or any plan name coming from payment provider
suspended_atstringWhether the organization is currently suspended
trial_info
nametypedescription
can_have_trialbooleanCanHaveInitialTrial is true if neither the organization nor the owner has never had a trial before
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
actual_secondsinteger | nullActual seconds
atstringLast updated date
auto_estimatesboolean | nullWhether estimates are based on task hours, premium feature
billableboolean | nullWhether the project is billable, premium feature
can_track_timeboolean-
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
estimated_secondsinteger | nullEstimated seconds
fixed_feenumberFixed fee, premium feature
idintegerProject ID
integration_providerstringIntegrations data
is_privatebooleanWhether the project is private
is_sharedbooleanShared Project
namestringName
permissionsstring-
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
shared_atstring-
shared_hashstring-
start_datestringStart date
statusstringStatus of the project (upcoming, active, ended, archived, deleted)
templateboolean | nullWhether the project is used as template, premium feature
template_idinteger | nullTemplate ID
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 items per page, default 201.

Response

200

Array of:

nametypedescription
activebooleanWhether the project is active or archived
actual_hoursinteger | nullActual hours
actual_secondsinteger | nullActual seconds
atstringLast updated date
auto_estimatesboolean | nullWhether estimates are based on task hours, premium feature
billableboolean | nullWhether the project is billable, premium feature
can_track_timeboolean-
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
estimated_secondsinteger | nullEstimated seconds
fixed_feenumberFixed fee, premium feature
idintegerProject ID
integration_providerstringIntegrations data
is_privatebooleanWhether the project is private
is_sharedbooleanShared Project
namestringName
permissionsstring-
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
shared_atstring-
shared_hashstring-
start_datestringStart date
statusstringStatus of the project (upcoming, active, ended, archived, deleted)
templateboolean | nullWhether the project is used as template, premium feature
template_idinteger | nullTemplate ID
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
creator_idintegerCreatorID the user who created the tag
deleted_atstringWhen was deleted
idintegerTag ID
integration_providerstringIntegrations data
namestringTag name
permissionsstring-
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
metabooleanfalseShould the response contain data for meta entities

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
client_namestring | null-
estimated_secondsinteger | nullEstimation time for this task in seconds
idintegerTask ID
integration_providerstringIntegrations data
namestringTask Name
permissionsstring-
project_colorstringMetadata
project_idintegerProject ID
project_namestring-
recurringbooleanWhether this is a recurring task
toggl_accounts_idstring | nullTask assignee, if set above this will be the toggl_account_id for that user
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
active_project_countinteger-
adminbooleanCurrent user is workspace admin
api_tokenstringdeprecated
atstringTimestamp of last workspace change
business_wsbooleanWorkspace on Premium subscription
csv_upload
nametypedescription
atstring-
log_idinteger-
CSV upload data
default_currencystringDefault currency, premium feature, optional, only for existing WS, will be 'USD' initially
default_hourly_ratenumberThe default hourly rate, premium feature, optional, only for existing WS, will be 0.0 initially
hide_start_end_timesboolean-
ical_enabledbooleanCalendar integration enabled
ical_urlstringURL of calendar
idintegerIdentifier of the workspace
last_modifiedstringLast modification of data in the workspace
logo_urlstringURL of workspace logo
max_data_retention_daysintegerHow far back free workspaces can access data.
namestringName of the workspace
only_admins_may_create_projectsbooleanOnly admins will be able to create projects, optional, only for existing WS, will be false initially
only_admins_may_create_tagsbooleanOnly admins will be able to create tags, optional, only for existing WS, will be false initially
only_admins_see_billable_ratesbooleanWhether only admins will be able to see billable rates, premium feature, optional, only for existing WS. Will be false initially
only_admins_see_team_dashboardbooleanOnly admins will be able to see the team dashboard, optional, only for existing WS, will be false initially
organization_idintegerIdentifier of the organization
permissionsstringPermissions list
premiumbooleanWorkspace on Starter subscription
profileintegerdeprecated
projects_billable_by_defaultbooleanNew projects billable by default
projects_private_by_defaultbooleanWorkspace setting for default project visbility.
rate_last_updatedstringTimestamp of last workspace rate update
reports_collapsebooleanWhether reports should be collapsed by default, optional, only for existing WS, will be true initially
rolestringRole of the current user in the workspace
roundingintegerDefault rounding, premium feature, optional, only for existing WS. 0 - nearest, 1 - round up, -1 - round down
rounding_minutesintegerDefault rounding in minutes, premium feature, optional, only for existing WS
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-
deprecated
suspended_atstringTimestamp of suspension
te_constraints
nametypedescription
description_presentboolean-
project_presentboolean-
tag_presentboolean-
task_presentboolean-
time_entry_constraints_enabledboolean-
Time entry constraints setting
working_hours_in_minutesintegerWorking hours in minutes

403

User does not have access to this resource.

500

Internal Server Error
© 2024 Toggl. All rights reserved.