--- title: "Me" method: GET path: "/me" tags: ["me"] --- # Me `GET /me` ## Request - Base URL: `https://localhost:8080/api/v9` - URL: `https://localhost:8080/api/v9/me` - Auth: HTTP basic - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns details for the current user. ## Query parameters - `with_related_data` boolean ## Response `200` Successful operation. - RelatedUserWithRelated - `api_token` string: will be omitted if empty - `at` string, date-time - `beginning_of_week` integer - `clients` ModelsClient[]: Clients, null if with_related_data was not set to true or if the user does not have any clients - `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 - `guid` string: GUID is a unique identifier for the client - `id` integer: Client ID - `name` string: Name of the client - `permissions` string: List of authorization permissions for this client. - `server_deleted_at` string: When was deleted, null if not deleted - `wid` integer: Workspace ID - `country_id` integer - `created_at` string, date-time - `default_workspace_id` integer - `email` string, email - `fullname` string - `has_password` boolean - `id` integer - `image_url` string - `intercom_hash` string: will be omitted if empty - `oauth_providers` string[] - `openid_email` string, email - `openid_enabled` boolean - `options` ModelsOptions - `projects` ModelsProject[]: Projects, null if with_related_data was not set to true or if the user does not have any projects - `active` boolean: Whether the project is active or archived - `actual_hours` integer, nullable: Actual hours - `actual_seconds` integer, nullable: Actual seconds - `at` string: Last updated date - `auto_estimates` boolean, nullable: Whether estimates are based on task hours, premium feature - `billable` boolean, nullable: Whether the project is billable, premium feature - `cid` integer: Client ID legacy field - `client_id` integer, nullable: Client ID - `color` string: Color - `created_at` string: Creation date - `currency` string, nullable: Currency, premium feature - `current_period` ModelsRecurringPeriod - `end_date` string - `start_date` string - `end_date` string: End date - `estimated_hours` integer, nullable: Estimated hours - `estimated_seconds` integer, nullable: Estimated seconds - `fixed_fee` number: Fixed fee, premium feature - `guid` string: GUID - `id` integer: Project ID - `is_private` boolean: Whether the project is private - `name` string: Name - `permissions` string - `rate` number: Hourly rate - `rate_last_updated` string, nullable: Last date for rate change - `recurring` boolean: Whether the project is recurring, premium feature - `recurring_parameters` ModelsRecurringProjectParameters[]: Project recurring parameters, premium feature - `custom_period` integer: Custom period, used when "period" field is "custom" - `estimated_seconds` integer: Estimated seconds - `parameter_end_date` string, nullable: Recurring end date - `parameter_start_date` string: Recurring start date - `period` string: Period - `project_start_date` string: Project start date - `server_deleted_at` string, nullable: Deletion date - `start_date` string: Start date - `status` string: Status of the project (upcoming, active, ended, archived, deleted) - `template` boolean, nullable: Whether the project is used as template, premium feature - `template_id` integer, nullable: Template ID - `wid` integer: Workspace ID legacy field - `workspace_id` integer: Workspace ID - `tags` ModelsTag[]: Tags, null if with_related_data was not set to true, or if the user does not have any tags - `at` string: When was created/last modified - `creator_id` integer: CreatorID the user who created the tag - `deleted_at` string, date-time: When was deleted - `id` integer: Tag ID - `name` string: Tag name - `permissions` string - `workspace_id` integer: Workspace ID - `tasks` ModelsTask[]: Tasks, null if with_related_data was not set to true or if the user does not have any tasks - `active` boolean: False when the task has been done - `at` string: When the task was created/last modified - `estimated_seconds` integer, nullable: Estimation time for this task in seconds - `id` integer: Task ID - `name` string: Task Name - `permissions` string - `project_id` integer: Project ID - `recurring` boolean: Whether this is a recurring task - `server_deleted_at` string, nullable: When the task was deleted - `toggl_accounts_id` string, nullable: Task assignee, if set above this will be the toggl_account_id for that user - `tracked_seconds` integer: The value tracked_seconds is in milliseconds, not in seconds. - `user_id` integer, nullable: Task assignee, if available - `workspace_id` integer: Workspace ID - `time_entries` ModelsTimeEntry[]: TimeEntries, null if with_related_data was not set to true or if the user does not have any time entries - `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, nullable: Time Entry description, null if not provided at creation/update - `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` string[]: Permission list - `pid` integer: Project ID, legacy field - `project_active` boolean - `project_color` string - `project_id` integer, nullable: Project ID. Can be null if project was not provided or project was later deleted - `project_name` string - `server_deleted_at` string, nullable: When was deleted, null if not deleted - `shared_with` ModelsTimeEntrySharedWith[]: Indicates who the time entry has been shared with - `accepted` boolean - `user_id` integer - `user_name` string - `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` integer[]: Tag IDs, null if tags were not provided or were later deleted - `tags` string[]: Tag names, null if tags were not provided or were later deleted - `task_id` integer, nullable: Task ID. Can be null if task was not provided or project was later deleted - `task_name` string - `tid` integer: Task ID, legacy field - `uid` integer: Time Entry creator ID, legacy field - `user_id` integer: Time Entry creator ID - `wid` integer: Workspace ID, legacy field - `workspace_id` integer: Workspace ID - `timezone` string - `updated_at` string, date-time - `workspaces` WorkspaceWorkspace[]: Workspaces, null if with_related_data was not set to true or if the user does not have any workspaces - `admin` boolean: Current user is workspace admin - `api_token` string: deprecated - `at` string: Timestamp of last workspace change - `business_ws` boolean: Workspace on Premium subscription - `csv_upload` ModelsCsvUpload - `at` string - `log_id` integer - `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_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 - `server_deleted_at` string, date-time: Timestamp of deletion - `subscription` ModelsSubscription - `auto_renew` boolean - `card_details` ModelsCardDetails - `added_at` string - `card_number` string - `card_type` string - `creator_id` integer - `creator_name` string - `expiry_date` string - `holder_name` string - `company_id` integer - `contact_detail` ModelsContactDetail - `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 - `created_at` string, date-time - `currency` string - `customer_id` integer - `deleted_at` string, date-time - `last_pricing_plan_id` integer - `organization_id` integer - `payment_details` ModelsPaymentDetail - `created_at` string - `currency` string - `customer_id` integer - `payment_type` string - `reference` string - `user_id` integer - `pricing_plan_id` integer - `renewal_at` string, date-time - `subscription_id` integer - `subscription_period` ModelsPeriod - `created_at` string - `finished_on` string - `started_on` string - `subscription_id` integer - `subscription_period_id` integer - `trial` boolean - `user_count` integer - `workspace_id` integer - `suspended_at` string, date-time: Timestamp of suspension - `te_constraints` ModelsTimeEntryConstraints - `description_present` boolean - `project_present` boolean - `tag_present` boolean - `task_present` boolean - `time_entry_constraints_enabled` boolean - `working_hours_in_minutes` integer: Working hours in minutes ## Other responses - `403`: User does not have access to this resource. - `404`: could not load user data - `500`: Internal Server Error --- [API](https://skmtc.dev/toggl/apis/toggl-api.md) - [All operations](https://skmtc.dev/toggl/apis/toggl-api/llms.txt) - [OpenAPI document](https://skmtc.dev/toggl/apis/toggl-api/revisions/3085aee16990?raw)