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

{
"api_token": {
"description": "will be omitted if empty",
"type": "string"
},
"at": {
"type": "string",
"format": "date-time"
},
"beginning_of_week": {
"type": "integer"
},
"country_id": {
"type": "integer"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"default_workspace_id": {
"type": "integer"
},
"email": {
"type": "string",
"format": "email"
},
"fullname": {
"type": "string"
},
"id": {
"type": "integer"
},
"image_url": {
"type": "string",
"example": "http://example.com"
},
"intercom_hash": {
"description": "will be omitted if empty",
"type": "string"
},
"openid_email": {
"type": "string",
"format": "email"
},
"openid_enabled": {
"type": "boolean"
},
"options": {
"object": {
"additionalProperties": "object"
},
"description": "will be omitted if empty"
},
"timezone": {
"type": "string"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
}

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_weekinteger-
country_idinteger-
current_passwordstring-
default_workspace_idinteger-
emailstring-
fullnamestring-
passwordstring-
timezonestring-

Response

{
"api_token": {
"description": "will be omitted if empty",
"type": "string"
},
"at": {
"type": "string",
"format": "date-time"
},
"beginning_of_week": {
"type": "integer"
},
"country_id": {
"type": "integer"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"default_workspace_id": {
"type": "integer"
},
"email": {
"type": "string",
"format": "email"
},
"fullname": {
"type": "string"
},
"id": {
"type": "integer"
},
"image_url": {
"type": "string",
"example": "http://example.com"
},
"openid_email": {
"type": "string",
"format": "email"
},
"openid_enabled": {
"type": "boolean"
},
"options": {
"object": {
"additionalProperties": "object"
},
"description": "will be omitted if empty"
},
"timezone": {
"type": "string"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
}

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"

Response

[
{
"archived": {
"type": "boolean"
},
"at": {
"type": "string"
},
"foreign_id": {
"description": "ForeignID - meta information for pipes, it should not be saved into DB!",
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"server_deleted_at": {
"type": "string"
},
"wid": {
"type": "integer"
}
}
]

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

Successful operation.

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

[
{
"features": {
"items": [
{
"enabled": {
"type": "boolean"
},
"feature_id": {
"type": "integer"
},
"name": {
"type": "string"
}
}
]
},
"workspace_id": {
"type": "integer"
}
}
]

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

{
"city": {
"type": "string"
},
"city_lat_long": {
"type": "string"
},
"country_code": {
"type": "string"
},
"country_name": {
"type": "string"
},
"state": {
"type": "string"
}
}

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

Successful operation

POST LostPassword

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
codestring-
passwordstring-
user_idinteger-

Response

Successful operation

POST LostPassword

https://api.track.toggl.com/api/v9/me/lost_passwords/{token_code}

Handles the users request to reset the password.

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

Parameters

Path

nametyperequireddescription
token_codestringtrueToken Code

Body

nametypedescription
emailstring-

Response

Successful operation

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

[
{
"admin": {
"type": "boolean"
},
"at": {
"type": "string",
"format": "date-time"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "integer"
},
"is_chargify": {
"type": "boolean"
},
"is_multi_workspace_enabled": {
"description": "IsMultiWorkspaceEnabled returns true if organization option is_multi_workspace_enabled is set",
"type": "boolean"
},
"is_unified": {
"type": "boolean"
},
"max_workspaces": {
"type": "integer"
},
"name": {
"type": "string"
},
"owner": {
"type": "boolean"
},
"payment_methods": {
"type": "string"
},
"pricing_plan_id": {
"type": "integer"
},
"server_deleted_at": {
"type": "string",
"format": "date-time"
},
"suspended_at": {
"type": "string"
},
"trial_info": {
"object": {
"last_pricing_plan_id": {
"type": "integer"
},
"next_payment_date": {
"type": "string"
},
"trial": {
"type": "boolean"
},
"trial_available": {
"type": "boolean"
},
"trial_end_date": {
"type": "string"
}
}
},
"user_count": {
"type": "integer"
}
}
]

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

Response

[
{
"active": {
"type": "boolean"
},
"actual_hours": {
"description": "End pro features",
"type": "integer"
},
"at": {
"type": "string"
},
"auto_estimates": {
"type": "boolean"
},
"billable": {
"description": "Pro features",
"type": "boolean"
},
"cid": {
"type": "integer"
},
"client_id": {
"type": "integer"
},
"color": {
"type": "string"
},
"created_at": {
"type": "string"
},
"currency": {
"type": "string"
},
"current_period": {
"object": {
"end_date": {
"type": "string"
},
"start_date": {
"type": "string"
}
}
},
"estimated_hours": {
"type": "integer"
},
"first_time_entry": {
"type": "string"
},
"fixed_fee": {
"type": "number"
},
"foreign_id": {
"description": "ForeignID - meta information for pipes, it should not be saved into DB!",
"type": "string"
},
"id": {
"type": "integer"
},
"is_private": {
"type": "boolean"
},
"name": {
"type": "string"
},
"rate": {
"type": "number"
},
"rate_last_updated": {
"type": "string"
},
"recurring": {
"type": "boolean"
},
"recurring_parameters": {
"items": [
{
"custom_period": {
"type": "integer"
},
"estimated_seconds": {
"type": "integer"
},
"parameter_end_date": {
"type": "string"
},
"parameter_start_date": {
"type": "string"
},
"period": {
"type": "string"
},
"project_start_date": {
"type": "string"
}
}
]
},
"server_deleted_at": {
"type": "string"
},
"template": {
"type": "boolean"
},
"wid": {
"description": "Ideally we'd want object_id type things, but for usual reasons we need to keep both around, so, that's that",
"type": "integer"
},
"workspace_id": {
"type": "integer"
}
}
]

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_idstringfalseStart project id

Response

[
{
"active": {
"type": "boolean"
},
"actual_hours": {
"description": "End pro features",
"type": "integer"
},
"at": {
"type": "string"
},
"auto_estimates": {
"type": "boolean"
},
"billable": {
"description": "Pro features",
"type": "boolean"
},
"cid": {
"type": "integer"
},
"client_id": {
"type": "integer"
},
"color": {
"type": "string"
},
"created_at": {
"type": "string"
},
"currency": {
"type": "string"
},
"current_period": {
"object": {
"end_date": {
"type": "string"
},
"start_date": {
"type": "string"
}
}
},
"estimated_hours": {
"type": "integer"
},
"first_time_entry": {
"type": "string"
},
"fixed_fee": {
"type": "number"
},
"foreign_id": {
"description": "ForeignID - meta information for pipes, it should not be saved into DB!",
"type": "string"
},
"id": {
"type": "integer"
},
"is_private": {
"type": "boolean"
},
"name": {
"type": "string"
},
"rate": {
"type": "number"
},
"rate_last_updated": {
"type": "string"
},
"recurring": {
"type": "boolean"
},
"recurring_parameters": {
"items": [
{
"custom_period": {
"type": "integer"
},
"estimated_seconds": {
"type": "integer"
},
"parameter_end_date": {
"type": "string"
},
"parameter_start_date": {
"type": "string"
},
"period": {
"type": "string"
},
"project_start_date": {
"type": "string"
}
}
]
},
"server_deleted_at": {
"type": "string"
},
"template": {
"type": "boolean"
},
"wid": {
"description": "Ideally we'd want object_id type things, but for usual reasons we need to keep both around, so, that's that",
"type": "integer"
},
"workspace_id": {
"type": "integer"
}
}
]

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>

Response

[
{
"at": {
"type": "string"
},
"deleted_at": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"workspace_id": {
"type": "integer"
}
}
]

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
sincestringfalsesince
include_not_activestringfalseInclude tasks where active=false

Response

[
{
"active": {
"type": "boolean"
},
"at": {
"type": "string"
},
"estimated_seconds": {
"type": "integer"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"project_id": {
"type": "integer"
},
"recurring": {
"type": "boolean"
},
"server_deleted_at": {
"type": "string"
},
"tracked_seconds": {
"type": "integer"
},
"user_id": {
"type": "integer"
},
"workspace_id": {
"type": "integer"
}
}
]

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

[
{
"created_at": {
"type": "string"
},
"frequency": {
"type": "integer"
},
"group_ids": {
"type": [
"integer"
]
},
"reminder_id": {
"type": "integer"
},
"threshold": {
"type": "integer"
},
"user_ids": {
"type": [
"integer"
]
},
"workspace_id": {
"type": "integer"
}
}
]

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

Successful operation
© 2022 Toggl. All rights reserved.