# "Me" Endpoints - GET

**URL:** <https://community.toggl.com/t/me-endpoints-get/161>\
**Category:** API References\
**Tags:** api, endpoints, documentation, parameters, me-endpoint\
**Created:** [November 21, 2024, 12:21pm UTC](https://community.toggl.com/t/me-endpoints-get/161 "2024-11-21T12:21:14Z")\
**Posts on this page:** 1\
**Page:** 1

<div class="post-metadata">

**Author:** ![Support](https://yyz2.discourse-cdn.com/flex012/user_avatar/community.toggl.com/support/32/1577_2.png) [@Support](https://community.toggl.com/u/Support)\
**Post date:** [November 21, 2024, 12:21pm UTC](https://community.toggl.com/t/me-endpoints-get/161/1 "2024-11-21T12:21:14Z")

</div>

## GET Me[​](https://engineering.toggl.com/docs/api/me/#get-me)

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

```

Returns details for the current user.

- cURL
- Go
- Ruby
- JavaScript
- Python
- Rust

```auto
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[​](https://engineering.toggl.com/docs/api/me/#parameters)

#### Query[​](https://engineering.toggl.com/docs/api/me/#query)

| name | type | required | description |
| --- | --- | --- | --- |
| with\_related\_data | boolean | false | Retrieve user related data (clients, projects, tasks, tags, workspaces, time entries, etc.) |

### Response[​](https://engineering.toggl.com/docs/api/me/#response)

#### 200[​](https://engineering.toggl.com/docs/api/me/#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[​](https://engineering.toggl.com/docs/api/me/#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[​](https://engineering.toggl.com/docs/api/me/#options)

##### projects[​](https://engineering.toggl.com/docs/api/me/#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[​](https://engineering.toggl.com/docs/api/me/#current_period)

| Name | Type | Description |
| --- | --- | --- |
| end\_date | string | - |
| start\_date | string | - |

##### recurring\_parameters[​](https://engineering.toggl.com/docs/api/me/#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[​](https://engineering.toggl.com/docs/api/me/#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[​](https://engineering.toggl.com/docs/api/me/#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[​](https://engineering.toggl.com/docs/api/me/#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[​](https://engineering.toggl.com/docs/api/me/#shared_with)

| Name | Type | Description |
| --- | --- | --- |
| accepted | boolean | - |
| user\_id | integer | - |
| user\_name | string | - |

##### workspaces[​](https://engineering.toggl.com/docs/api/me/#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[​](https://engineering.toggl.com/docs/api/me/#csv_upload)

| Name | Type | Description |
| --- | --- | --- |
| at | string | - |
| log\_id | integer | - |

##### subscription[​](https://engineering.toggl.com/docs/api/me/#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[​](https://engineering.toggl.com/docs/api/me/#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[​](https://engineering.toggl.com/docs/api/me/#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[​](https://engineering.toggl.com/docs/api/me/#payment_details)

| Name | Type | Description |
| --- | --- | --- |
| created\_at | string | - |
| currency | string | - |
| customer\_id | integer | - |
| payment\_type | string | - |
| reference | string | - |
| user\_id | integer | - |

##### subscription\_period[​](https://engineering.toggl.com/docs/api/me/#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[​](https://engineering.toggl.com/docs/api/me/#te_constraints)

| Name | Type | Description |
| --- | --- | --- |
| description\_present | boolean | - |
| project\_present | boolean | - |
| tag\_present | boolean | - |
| task\_present | boolean | - |
| time\_entry\_constraints\_enabled | boolean | - |

#### 403[​](https://engineering.toggl.com/docs/api/me/#403)

User does not have access to this resource.

#### 404[​](https://engineering.toggl.com/docs/api/me/#404)

could not load user data

#### 500[​](https://engineering.toggl.com/docs/api/me/#500)

Internal Server Error