"Me" Endpoints - GET

Tech Discussions API References
, , , ,
1

GET Me​

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

Returns details for the current user.

  • cURL
  • Go
  • Ruby
  • JavaScript
  • Python
  • Rust
extern crate tokio;extern crate serde_json;use reqwest::{Client};use reqwest::header::{CONTENT_TYPE};#[tokio::main]async fn main() -> Result<(), reqwest::Error> {  let client = Client::new().basic_auth("<email>", "<password>");  let json = client.request(Method::GET, "https://api.track.toggl.com/api/v9/me".to_string())  .header(CONTENT_TYPE, "application/json")  .send()  .await?  .json()  .await?;    println!("{:#?}", json);  Ok(())}

Parameters​

Query​

name type required description
with_related_data boolean false Retrieve user related data (clients, projects, tasks, tags, workspaces, time entries, etc.)

Response​

200​

Name Type Description
api_token string will be omitted if empty
at string -
authorization_updated_at string AuthorizationUpdatedAt timestamp when the authorization user session object was last updated.
beginning_of_week integer -
clients Array of object Clients, null if with_related_data was not set to true or if the user does not have any clients
country_id integer -
created_at string -
default_workspace_id integer -
email string -
fullname string -
has_password boolean -
id integer -
image_url string -
intercom_hash string will be omitted if empty
oauth_providers Array of string -
openid_email string -
openid_enabled boolean -
options object will be omitted if empty
projects Array of object Projects, null if with_related_data was not set to true or if the user does not have any projects
tags Array of object Tags, null if with_related_data was not set to true, or if the user does not have any tags
tasks Array of object Tasks, null if with_related_data was not set to true or if the user does not have any tasks
time_entries Array of object TimeEntries, null if with_related_data was not set to true or if the user does not have any time entries
timezone string -
updated_at string -
workspaces Array of object Workspaces, null if with_related_data was not set to true or if the user does not have any workspaces
clients​
Name Type Description
archived boolean IsArchived is true if the client is archived
at string When was the last update
creator_id integer CreatorID is the ID of the user who created the client
id integer Client ID
integration_ext_id string The external ID of the linked entity in the external system (e.g. JIRA/SalesForce)
integration_ext_type string The external type of the linked entity in the external system (e.g. JIRA/SalesForce)
integration_provider string The provider (e.g. JIRA/SalesForce) that has an entity linked to this Toggl Track entity
name string Name of the client
notes string -
permissions string List of authorization permissions for this client.
wid integer Workspace ID
options​
projects​
Name Type Description
active boolean Whether the project is active or archived
actual_hours integer null
actual_seconds integer null
at string Last updated date
auto_estimates boolean null
billable boolean null
can_track_time boolean -
cid integer Client ID legacy field
client_id integer null
color string Color
created_at string Creation date
currency string null
current_period object Current project period, premium feature
end_date string End date
estimated_hours integer null
estimated_seconds integer null
fixed_fee number Fixed fee, premium feature
id integer Project ID
integration_ext_id string The external ID of the linked entity in the external system (e.g. JIRA/SalesForce)
integration_ext_type string The external type of the linked entity in the external system (e.g. JIRA/SalesForce)
integration_provider string The provider (e.g. JIRA/SalesForce) that has an entity linked to this Toggl Track entity
is_private boolean Whether the project is private
is_shared boolean Shared Project
name string Name
permissions string -
pinned boolean -
rate number Hourly rate
rate_last_updated string null
recurring boolean Whether the project is recurring, premium feature
recurring_parameters Array of object Project recurring parameters, premium feature
shared_at string -
shared_hash string -
start_date string Start date
status string Status of the project (upcoming, active, ended, archived, deleted)
tasks_count integer -
template boolean null
template_id integer null
wid integer Workspace ID legacy field
workspace_id integer Workspace ID
current_period​
Name Type Description
end_date string -
start_date string -
recurring_parameters​
Name Type Description
custom_period integer Custom period, used when “period” field is “custom”
estimated_seconds integer Estimated seconds
parameter_end_date string null
parameter_start_date string Recurring start date
period string Period
project_start_date string Project start date
tags​
Name Type Description
at string When was created/last modified
creator_id integer CreatorID the user who created the tag
deleted_at string When was deleted
id integer Tag ID
integration_ext_id string The external ID of the linked entity in the external system (e.g. JIRA/SalesForce)
integration_ext_type string The external type of the linked entity in the external system (e.g. JIRA/SalesForce)
integration_provider string The provider (e.g. JIRA/SalesForce) that has an entity linked to this Toggl Track entity
name string Tag name
permissions string -
workspace_id integer Workspace ID
tasks​
Name Type Description
active boolean False when the task has been done
at string When the task was created/last modified
client_name string null
due_date string null
estimated_seconds integer null
id integer Task ID
integration_ext_id string The external ID of the linked entity in the external system (e.g. JIRA/SalesForce)
integration_ext_type string The external type of the linked entity in the external system (e.g. JIRA/SalesForce)
integration_provider string The provider (e.g. JIRA/SalesForce) that has an entity linked to this Toggl Track entity
name string Task Name
permissions string -
project_billable boolean -
project_color string Metadata
project_id integer Project ID
project_name string -
rate number Rate for this task
rate_last_updated string null
recurring boolean Whether this is a recurring task
toggl_accounts_id string null
tracked_seconds integer The value tracked_seconds is in milliseconds, not in seconds.
user_id integer null
workspace_id integer Workspace ID
time_entries​
Name Type Description
at string When was last updated
billable boolean Whether the time entry is marked as billable
client_name string Related entities meta fields - if requested
description string null
duration integer Time entry duration. For running entries should be negative, preferable -1
duronly boolean Used 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.
id integer Time Entry ID
permissions Array of string Permission list
pid integer Project ID, legacy field
project_active boolean -
project_billable boolean -
project_color string -
project_id integer null
project_name string -
shared_with Array of object Indicates who the time entry has been shared with
start string Start time in UTC
stop string Stop time in UTC, can be null if it’s still running or created with “duration” and “duronly” fields
tag_ids Array of integer Tag IDs, null if tags were not provided or were later deleted
tags Array of string Tag names, null if tags were not provided or were later deleted
task_id integer null
task_name string -
tid integer Task ID, legacy field
uid integer Time Entry creator ID, legacy field
user_avatar_url string -
user_id integer Time Entry creator ID
user_name string -
wid integer Workspace ID, legacy field
workspace_id integer Workspace ID
shared_with​
Name Type Description
accepted boolean -
user_id integer -
user_name string -
workspaces​
Name Type Description
admin boolean Current user is workspace admin Deprecated
api_token string deprecated
at string Timestamp of last workspace change
business_ws boolean Workspace on Premium subscription
csv_upload object CSV upload data
default_currency string Default currency, premium feature, optional, only for existing WS, will be ‘USD’ initially
default_hourly_rate number The default hourly rate, premium feature, optional, only for existing WS, will be 0.0 initially
hide_start_end_times boolean -
ical_enabled boolean Calendar integration enabled
ical_url string URL of calendar
id integer Identifier of the workspace
last_modified string Last modification of data in the workspace
logo_url string URL of workspace logo
max_data_retention_days integer How far back free workspaces can access data.
name string Name of the workspace
only_admins_may_create_projects boolean Only admins will be able to create projects, optional, only for existing WS, will be false initially
only_admins_may_create_tags boolean Only admins will be able to create tags, optional, only for existing WS, will be false initially
only_admins_see_billable_rates boolean Whether only admins will be able to see billable rates, premium feature, optional, only for existing WS. Will be false initially
only_admins_see_team_dashboard boolean Only admins will be able to see the team dashboard, optional, only for existing WS, will be false initially
organization_id integer Identifier of the organization
permissions string Permissions list
premium boolean Workspace on Starter subscription
profile integer deprecated
projects_billable_by_default boolean New projects billable by default
projects_enforce_billable boolean Whether tracking time to projects will enforce billable setting to be respected.
projects_private_by_default boolean Workspace setting for default project visbility.
rate_last_updated string Timestamp of last workspace rate update
reports_collapse boolean Whether reports should be collapsed by default, optional, only for existing WS, will be true initially
role string Role of the current user in the workspace
rounding integer Default rounding, premium feature, optional, only for existing WS. 0 - nearest, 1 - round up, -1 - round down
rounding_minutes integer Default rounding in minutes, premium feature, optional, only for existing WS
subscription object deprecated
suspended_at string Timestamp of suspension
te_constraints object Time entry constraints setting
working_hours_in_minutes integer Working hours in minutes
csv_upload​
Name Type Description
at string -
log_id integer -
subscription​
Name Type Description
auto_renew boolean -
card_details object -
company_id integer -
contact_detail object -
created_at string -
currency string -
customer_id integer -
deleted_at string -
last_pricing_plan_id integer -
organization_id integer -
payment_details object -
pricing_plan_id integer -
renewal_at string -
subscription_id integer -
subscription_period object -
workspace_id integer -
card_details​
Name Type Description
added_at string -
card_number string -
card_type string -
creator_id integer -
creator_name string -
expiry_date string -
holder_name string -
contact_detail​
Name Type Description
company_address string -
company_city string -
company_name string -
contact_detail_id integer -
contact_email string -
contact_person string -
country_id integer -
country_subdivision_id integer -
created_at string -
customer_id integer -
is_eu_resident boolean -
updated_at string -
user_id integer -
vat_number string -
vat_number_valid boolean DEPRECATED
vat_number_validated_at string DEPRECATED
zip_code string -
payment_details​
Name Type Description
created_at string -
currency string -
customer_id integer -
payment_type string -
reference string -
user_id integer -
subscription_period​
Name Type Description
created_at string -
finished_on string -
started_on string -
subscription_id integer -
subscription_period_id integer -
trial boolean -
user_count integer -
te_constraints​
Name Type Description
description_present boolean -
project_present boolean -
tag_present boolean -
task_present boolean -
time_entry_constraints_enabled boolean -

403​

User does not have access to this resource.

404​

could not load user data

500​

Internal Server Error