Share via


Toggl Track (Independent Publisher) (Preview)

The only time tracking software that builds custom reports from your team's time data to maximize productivity and revenue. Our time tracking solution records a calendar timeline of all your work activities throughout the day.

This connector is available in the following products and regions:

Service Class Regions
Copilot Studio Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Troy Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Connector Metadata
Publisher troystaylor
Website https://toggl.com/track/automated-time-tracker/
Privacy policy https://toggl.com/legal/track/privacy/
Categories Productivity

Toggl Track

The only time tracking software that builds custom reports from your team's time data to maximize productivity and revenue. Our time tracking solution records a calendar timeline of all your work activities throughout the day.

Publisher: Troy Taylor, Hitachi Solutions

Prerequisites

You must sign up for an account with Toggl.

Obtaining Credentials

This connector uses basic authentication with your email address and password.

Supported Operations

Get current user

Returns details for the current user.

Update current user

Updates details for the current user.

Get user clients

Get clients for the current user.

Get user features

Get features available to the current user.

Get user location

Returns the client's IP-based location. If no data is present, empty response will be yielded.

Check authentication

Used to check if authentication works.

Get user organizations

Get all organizations a given user is part of.

Get user projects

Get projects for the current user.

Get user projects paginated

Get paginated projects for the current user.

Get user tags

Returns tags for the current user.

Get user tasks

Returns tasks from projects in which the user is participating.

Get track reminders

Returns a list of track reminders.

Get web timer

Get web timer configuration.

Get user workspaces

Lists workspaces for given user.

Get time entries

Lists latest time entries.

Get current time entry

Load running time entry for user ID.

Get time entry by ID

Load time entry by ID that is accessible by the current user.

Get workspace users (organization level)

Returns any users who belong to the workspace directly or through at least one group.

Get workspace users

List all users for a given workspace.

Get workspace project users

List all projects users for a given workspace.

Get user clients

Get clients for the current user.

Get user organizations

Get all organizations a given user is part of.

Get workspace users (organization level)

Returns any users who belong to the workspace directly or through at least one group.

Get user projects

Get projects for the current user.

Get user projects paginated

Get paginated projects for the current user.

Get workspace project users

List all projects users for a given workspace.

Get workspace projects

Get projects for given workspace.

Get workspace project

Get project for given workspace.

Get user tags

Returns tags for the current user.

Get user tasks

Returns tasks from projects in which the user is participating.

Get user workspaces

Lists workspaces for given user.

Create time entry

Creates a new workspace time entry.

Delete time entry

Deletes a workspace time entry.

Update time entry

Updates a workspace time entry.

Bulk edit time entries

Bulk editing time entries. Patch will be executed partially when there are errors with some records. No transaction, no rollback.

Stop time entry

Stops a workspace time entry.

Get workspace users (organization level)

Returns any users who belong to the workspace directly or through at least one group.

Get single workspace

Get information of single workspace.

Get rates list

Get rates by level (workspace|project|task|user).

Get workspace statistics

Returns workspace admins list, members count and groups count.

Get workspace time entry constraints

Get the time entry constraints for a given workspace.

Get workspace track reminders

Returns a list of track reminders.

Get workspace users

List all users for a given workspace.

Get workspace project users

List all projects users for a given workspace.

Get workspace projects

Get projects for given workspace.

Get workspace project

Get project for given workspace.

Get time entries

Lists latest time entries.

Get current time entry

Load running time entry for user ID.

Get time entry by ID

Load time entry by ID that is accessible by the current user.

When a time entry is created

Triggers when a new time entry is created in the workspace.

When a time entry is updated

Triggers when an existing time entry is modified in the workspace.

When a time entry is deleted

Triggers when a time entry is deleted from the workspace.

When a time entry is started

Triggers when a time entry is started (timer begins) in the workspace.

When a time entry is stopped

Triggers when a running time entry is stopped in the workspace.

Known Issues and Limitations

There are no known issues at this time.

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Username securestring The Username for this api True
Password securestring The Password for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Bulk edit time entries

Bulk editing time entries. Patch will be executed partially when there are errors with some records. No transaction, no rollback.

Check authentication

Used to check if authentication works.

Create time entry

Creates a new workspace TimeEntry.

Delete time entry

Deletes a workspace time entry.

Get current time entry

Load running time entry for user ID.

Get current user

Returns details for the current user.

Get rates list

Get rates by level (workspace|project|task|user).

Get single workspace

Get information of single workspace.

Get time entries

Lists latest time entries.

Get time entry by ID

Load time entry by ID that is accessible by the current user.

Get track reminders

Returns a list of track reminders.

Get user clients

Get clients for the current user.

Get user features

Get features available to the current user.

Get user location

Returns the client's IP-based location. If no data is present, empty response will be yielded.

Get user organizations

Get all organizations a given user is part of.

Get user projects

Get projects for the current user.

Get user projects paginated

Get paginated projects for the current user.

Get user tags

Returns tags for the current user.

Get user tasks

Returns tasks from projects in which the user is participating.

Get user workspaces

Lists workspaces for given user.

Get web timer

Get web timer configuration.

Get workspace project

Get project for given workspace.

Get workspace project users

List all projects users for a given workspace.

Get workspace projects

Get projects for given workspace.

Get workspace statistics

Returns workspace admins list, members count and groups count.

Get workspace time entry constraints

Get the time entry constraints for a given workspace.

Get workspace track reminders

Returns a list of track reminders.

Get workspace users

List all users for a given workspace.

Get workspace users (organization level)

Returns any users who belong to the workspace directly or through at least one group.

Stop time entry

Stops a workspace time entry.

Update current user

Updates details for the current user.

Update time entry

Updates a workspace time entry.

Bulk edit time entries

Bulk editing time entries. Patch will be executed partially when there are errors with some records. No transaction, no rollback.

Parameters

Name Key Required Type Description
Workspace ID
workspace_id True integer

Numeric ID of the workspace.

Time Entry IDs
time_entry_ids True string

Numeric IDs of time_entries, separated by comma. E.g.: 204301830,202700150,202687559. The limit is 100 IDs per request.

Include Meta Data
meta boolean

Should the response contain data for meta entities.

Operation
op True string

Operation (add/remove/replace).

Path
path True string

The path to the entity to patch (e.g. /description).

Value
value object

The new value for the entity in path.

Returns

Check authentication

Used to check if authentication works.

Create time entry

Creates a new workspace TimeEntry.

Parameters

Name Key Required Type Description
Workspace ID
workspace_id True integer

Numeric ID of the workspace.

Include Meta Data
meta boolean

Should the response contain data for meta entities.

Billable
billable boolean

Whether the time entry is marked as billable, optional, default false.

Created With
created_with string

Must be provided when creating a time entry and should identify the service/application used to create it.

Description
description string

Time entry description, optional.

Duration
duration integer

Time entry duration. For running entries should be negative, preferable -1.

Duration Only
duronly boolean

Deprecated: Used to create a time entry with a duration but without a stop time. This parameter can be ignored.

Origin Feature
origin_feature string

Origin feature name.

Visible Goals Count
visible_goals_count integer

Number of visible goals.

Expense IDs
expense_ids array of integer

Work Expenses associated with the Time Entry.

Project ID (Legacy)
pid integer

Project ID, legacy field.

Project ID
project_id integer

Project ID, optional.

Shared With User IDs
shared_with_user_ids array of integer

List of user IDs to share this time entry with.

Start Time
start string

Start time in UTC, required for creation. Format: 2006-01-02T15:04:05Z.

Start Date
start_date string

If provided during creation, the date part will take precedence over the date part of 'start'. Format: 2006-11-07.

Stop Time
stop string

Stop time in UTC, can be omitted if it's still running or created with 'duration'. If 'stop' and 'duration' are provided, values must be consistent (start + duration == stop).

Tag Action
tag_action string

Can be 'add' or 'delete'. Used when updating an existing time entry.

Tag IDs
tag_ids array of integer

IDs of tags to add/remove.

Tags
tags array of string

Names of tags to add/remove. If name does not exist as tag, one will be created automatically.

Task ID
task_id integer

Task ID, optional.

Task ID (Legacy)
tid integer

Task ID, legacy field.

User ID (Legacy)
uid integer

Time Entry creator ID, legacy field.

User ID
user_id integer

Time Entry creator ID, if omitted will use the requester user ID.

Workspace ID (Legacy)
wid integer

Workspace ID, legacy field.

Workspace ID
workspace_id integer

Workspace ID, required.

Returns

Body
TimeEntry

Delete time entry

Deletes a workspace time entry.

Parameters

Name Key Required Type Description
Workspace ID
workspace_id True integer

Numeric ID of the workspace.

Time Entry ID
time_entry_id True integer

TimeEntry ID.

Get current time entry

Load running time entry for user ID.

Returns

Body
TimeEntry

Get current user

Returns details for the current user.

Parameters

Name Key Required Type Description
Include Related Data
with_related_data boolean

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

Returns

Get rates list

Get rates by level (workspace|project|task|user).

Parameters

Name Key Required Type Description
Workspace ID
workspace_id True integer

Numeric ID of the workspace.

Level
level True string

Rates level: workspace, project, task or user.

Level ID
level_id True integer

Numeric ID of the entity level.

Rate Type
type string

Type of rate values to be returned: billable_rates or labor_costs. Default is billable_rates.

Returns

response
array of Rate

Get single workspace

Get information of single workspace.

Parameters

Name Key Required Type Description
Workspace ID
workspace_id True integer

Numeric ID of the workspace.

Returns

Body
Workspace

Get time entries

Lists latest time entries.

Parameters

Name Key Required Type Description
Include Meta Data
meta boolean

Should the response contain data for meta entities.

Include Sharing
include_sharing boolean

Include sharing details in the response.

Since Date
since integer

Retrieve items created/modified/deleted since this date using UNIX timestamp.

Before Date
before string

Get entries with start time, before given date (YYYY-MM-DD) or with time in RFC3339 format.

Start Date
start_date string

Get entries with start time, from start_date YYYY-MM-DD or with time in RFC3339 format. To be used with end_date.

End Date
end_date string

Get entries with start time, until end_date YYYY-MM-DD or with time in RFC3339 format. To be used with start_date.

Returns

Get time entry by ID

Load time entry by ID that is accessible by the current user.

Parameters

Name Key Required Type Description
Time Entry ID
time_entry_id True integer

TimeEntry ID.

Include Meta Data
meta boolean

Should the response contain data for meta entities.

Include Sharing
include_sharing boolean

Include sharing details in the response.

Returns

Body
TimeEntry

Get track reminders

Returns a list of track reminders.

Returns

Get user clients

Get clients for the current user.

Parameters

Name Key Required Type Description
Since Date
since integer

Retrieve items created/modified/deleted since this date using UNIX timestamp.

Returns

response
array of Client

Get user features

Get features available to the current user.

Returns

Get user location

Returns the client's IP-based location. If no data is present, empty response will be yielded.

Returns

Get user organizations

Get all organizations a given user is part of.

Returns

Get user projects

Get projects for the current user.

Parameters

Name Key Required Type Description
Include Archived
include_archived string

Include archived projects.

Since Date
since integer

Retrieve items created/modified/deleted since this date using UNIX timestamp.

Returns

response
array of Project

Get user projects paginated

Get paginated projects for the current user.

Parameters

Name Key Required Type Description
Start Project ID
start_project_id integer

Project ID to resume the next pagination from.

Since Date
since integer

Retrieve items created/modified/deleted since this date using UNIX timestamp.

Items Per Page
per_page integer

Number of items per page, default 201.

Returns

response
array of Project

Get user tags

Returns tags for the current user.

Parameters

Name Key Required Type Description
Since Date
since integer

Retrieve items created/modified/deleted since this date using UNIX timestamp.

Returns

response
array of Tag

Get user tasks

Returns tasks from projects in which the user is participating.

Parameters

Name Key Required Type Description
Include Meta Data
meta boolean

Should the response contain data for meta entities.

Since Date
since integer

Retrieve items created/modified/deleted since this date using UNIX timestamp.

Include Inactive Tasks
include_not_active string

Include tasks marked as done.

Pagination Offset
offset integer

Offset to resume the next pagination from.

Items Per Page
per_page integer

Number of items per page, default 201.

Returns

response
array of Task

Get user workspaces

Lists workspaces for given user.

Parameters

Name Key Required Type Description
Since Date
since integer

Retrieve items created/modified/deleted since this date using UNIX timestamp.

Returns

Get web timer

Get web timer configuration.

Get workspace project

Get project for given workspace.

Parameters

Name Key Required Type Description
Workspace ID
workspace_id True integer

Numeric ID of the workspace.

Project ID
project_id True integer

Numeric ID of the project.

Returns

Body
Project

Get workspace project users

List all projects users for a given workspace.

Parameters

Name Key Required Type Description
Workspace ID
workspace_id True integer

Numeric ID of the workspace.

Project IDs
project_ids string

Numeric IDs of projects, comma-separated.

User ID
user_id string

Numeric ID of user, if passed returns only project users for this user's projects.

Include Group Members
with_group_members boolean

Include group members.

Returns

Get workspace projects

Get projects for given workspace.

Parameters

Name Key Required Type Description
Workspace ID
workspace_id True integer

Numeric ID of the workspace.

Sort Pinned
sort_pinned True boolean

Place pinned projects at top of response.

Active Users Only
active boolean

Returns only active users.

Since Date
since integer

Retrieve items created/modified/deleted since this date using UNIX timestamp.

Billable
billable boolean

Filter by billable status.

User IDs
user_ids array

User IDs to filter by.

Client IDs
client_ids array

Client IDs to filter by.

Group IDs
group_ids array

Group IDs to filter by.

Project IDs
project_ids string

Numeric IDs of projects, comma-separated.

Statuses
statuses array

Project statuses to filter by.

Name Filter
name string

Workspace user name to filter by.

Page Number
page integer

Page number.

Sort Field
sort_field True string

Field to sort by.

Sort Order
sort_order True string

Sort order (asc/desc).

Only Templates
only_templates True boolean

Return only project templates.

Only My Projects
only_me boolean

Get only projects assigned to the current user.

Items Per Page
per_page integer

Number of items per page, default 201.

Returns

response
array of Project

Get workspace statistics

Returns workspace admins list, members count and groups count.

Parameters

Name Key Required Type Description
Workspace ID
workspace_id True integer

Numeric ID of the workspace.

Returns

Get workspace time entry constraints

Get the time entry constraints for a given workspace.

Parameters

Name Key Required Type Description
Workspace ID
workspace_id True integer

Numeric ID of the workspace.

Returns

Get workspace track reminders

Returns a list of track reminders.

Parameters

Name Key Required Type Description
Workspace ID
workspace_id True integer

Numeric ID of the workspace.

Returns

Get workspace users

List all users for a given workspace.

Parameters

Name Key Required Type Description
Workspace ID
workspace_id True integer

Numeric ID of the workspace.

Exclude Deleted
exclude_deleted boolean

Exclude deleted records in the response.

Returns

Get workspace users (organization level)

Returns any users who belong to the workspace directly or through at least one group.

Parameters

Name Key Required Type Description
Organization ID
organization_id True integer

Numeric ID of the organization.

Workspace ID
workspace_id True integer

Numeric ID of the workspace.

Page Number
page integer

Page number.

Items Per Page
per_page integer

Number of items per page, default 201.

Custom Rates Filter
custom_rates boolean

Returns only users with or without a custom hourly rate respectively.

Active Users Only
active boolean

Returns only active users.

Name Filter
name string

Workspace user name to filter by.

Search Filter
search string

Workspace filter by name or email.

Returns

Stop time entry

Stops a workspace time entry.

Parameters

Name Key Required Type Description
Workspace ID
workspace_id True integer

Numeric ID of the workspace.

Time Entry ID
time_entry_id True integer

TimeEntry ID.

Returns

Body
TimeEntry

Update current user

Updates details for the current user.

Parameters

Name Key Required Type Description
Beginning of Week
beginning_of_week integer

User's first day of the week. Sunday: 0, Monday: 1, etc.

Country ID
country_id integer

User's country ID.

Current Password
current_password string

User's current password (used to change the current password).

Default Workspace ID
default_workspace_id integer

User's default workspace ID.

Email
email string

User's email address.

Full Name
fullname string

User's full name.

New Password
password string

User's new password (current one must also be provided).

Timezone
timezone string

User's timezone.

Returns

Update time entry

Updates a workspace time entry.

Parameters

Name Key Required Type Description
Workspace ID
workspace_id True integer

Numeric ID of the workspace.

Time Entry ID
time_entry_id True integer

TimeEntry ID.

Include Meta Data
meta boolean

Should the response contain data for meta entities.

Include Sharing
include_sharing boolean

Include sharing details in the response.

Billable
billable boolean

Whether the time entry is marked as billable, optional, default false.

Created With
created_with string

Must be provided when creating a time entry and should identify the service/application used to create it.

Description
description string

Time entry description, optional.

Duration
duration integer

Time entry duration. For running entries should be negative, preferable -1.

Duration Only
duronly boolean

Deprecated: Used to create a time entry with a duration but without a stop time. This parameter can be ignored.

Origin Feature
origin_feature string

Origin feature name.

Visible Goals Count
visible_goals_count integer

Number of visible goals.

Expense IDs
expense_ids array of integer

Work Expenses associated with the Time Entry.

Project ID (Legacy)
pid integer

Project ID, legacy field.

Project ID
project_id integer

Project ID, optional.

Shared With User IDs
shared_with_user_ids array of integer

List of user IDs to share this time entry with.

Start Time
start string

Start time in UTC, required for creation. Format: 2006-01-02T15:04:05Z.

Start Date
start_date string

If provided during creation, the date part will take precedence over the date part of 'start'. Format: 2006-11-07.

Stop Time
stop string

Stop time in UTC, can be omitted if it's still running or created with 'duration'. If 'stop' and 'duration' are provided, values must be consistent (start + duration == stop).

Tag Action
tag_action string

Can be 'add' or 'delete'. Used when updating an existing time entry.

Tag IDs
tag_ids array of integer

IDs of tags to add/remove.

Tags
tags array of string

Names of tags to add/remove. If name does not exist as tag, one will be created automatically.

Task ID
task_id integer

Task ID, optional.

Task ID (Legacy)
tid integer

Task ID, legacy field.

User ID (Legacy)
uid integer

Time Entry creator ID, legacy field.

User ID
user_id integer

Time Entry creator ID, if omitted will use the requester user ID.

Workspace ID (Legacy)
wid integer

Workspace ID, legacy field.

Workspace ID
workspace_id integer

Workspace ID, required.

Returns

Body
TimeEntry

Triggers

When a time entry is created

Triggers when a new time entry is created in the workspace.

When a time entry is deleted

Triggers when a time entry is deleted from the workspace.

When a time entry is started

Triggers when a time entry is started (timer begins) in the workspace.

When a time entry is stopped

Triggers when a running time entry is stopped in the workspace.

When a time entry is updated

Triggers when an existing time entry is modified in the workspace.

When a time entry is created

Triggers when a new time entry is created in the workspace.

Parameters

Name Key Required Type Description
Workspace ID
workspace_id True integer

Numeric ID of the workspace.

Entity
entity string

Toggl Track business entity to filter.

Action
action string

Type of modification applied to the entity.

Returns

When a time entry is deleted

Triggers when a time entry is deleted from the workspace.

Parameters

Name Key Required Type Description
Workspace ID
workspace_id True integer

Numeric ID of the workspace.

Entity
entity string

Toggl Track business entity to filter.

Action
action string

Type of modification applied to the entity.

Returns

When a time entry is started

Triggers when a time entry is started (timer begins) in the workspace.

Parameters

Name Key Required Type Description
Workspace ID
workspace_id True integer

Numeric ID of the workspace.

Entity
entity string

Toggl Track business entity to filter.

Action
action string

Type of modification applied to the entity.

Returns

When a time entry is stopped

Triggers when a running time entry is stopped in the workspace.

Parameters

Name Key Required Type Description
Workspace ID
workspace_id True integer

Numeric ID of the workspace.

Entity
entity string

Toggl Track business entity to filter.

Action
action string

Type of modification applied to the entity.

Returns

When a time entry is updated

Triggers when an existing time entry is modified in the workspace.

Parameters

Name Key Required Type Description
Workspace ID
workspace_id True integer

Numeric ID of the workspace.

Entity
entity string

Toggl Track business entity to filter.

Action
action string

Type of modification applied to the entity.

Returns

Definitions

UserResponse

Name Path Type Description
2FA Enabled
2fa_enabled boolean

Two-factor authentication enabled status.

API Token
api_token string

API token, will be omitted if empty.

Last Updated
at string

Last update timestamp.

Authorization Updated
authorization_updated_at string

Timestamp when the authorization user session object was last updated.

Beginning of Week
beginning_of_week integer

User's first day of the week (0=Sunday, 1=Monday, etc.).

Clients
clients array of Client

Clients, null if with_related_data was not set to true.

Country ID
country_id integer

User's country ID.

Created At
created_at string

User creation timestamp.

Default Workspace ID
default_workspace_id integer

User's default workspace ID.

Email
email string

User's email address.

Full Name
fullname string

User's full name.

Has Password
has_password boolean

Whether user has a password set.

User ID
id integer

User ID.

Image URL
image_url string

User's profile image URL.

Intercom Hash
intercom_hash string

Intercom hash, will be omitted if empty.

OAuth Providers
oauth_providers array of string

OAuth providers available to the user.

OpenID Email
openid_email string

OpenID email address.

OpenID Enabled
openid_enabled boolean

OpenID authentication enabled status.

Options
options object

User options, will be omitted if empty.

Projects
projects array of Project

Projects, null if with_related_data was not set to true.

Tags
tags array of Tag

Tags, null if with_related_data was not set to true.

Tasks
tasks array of Task

Tasks, null if with_related_data was not set to true.

Time Entries
time_entries array of TimeEntry

Time entries, null if with_related_data was not set to true.

Timezone
timezone string

User's timezone.

Updated At
updated_at string

User last update timestamp.

Workspaces
workspaces array of Workspace

Workspaces, null if with_related_data was not set to true.

UserBasicResponse

Name Path Type Description
2FA Enabled
2fa_enabled boolean

Two-factor authentication enabled status.

API Token
api_token string

API token, will be omitted if empty.

Last Updated
at string

Last update timestamp.

Beginning of Week
beginning_of_week integer

User's first day of the week.

Country ID
country_id integer

User's country ID.

Created At
created_at string

User creation timestamp.

Default Workspace ID
default_workspace_id integer

User's default workspace ID.

Email
email string

User's email address.

Full Name
fullname string

User's full name.

Has Password
has_password boolean

Whether user has a password set.

User ID
id integer

User ID.

Image URL
image_url string

User's profile image URL.

OpenID Email
openid_email string

OpenID email address.

OpenID Enabled
openid_enabled boolean

OpenID authentication enabled status.

Options
options object

User options, will be omitted if empty.

Timezone
timezone string

User's timezone.

Updated At
updated_at string

User last update timestamp.

Client

Name Path Type Description
Archived
archived boolean

Is true if the client is archived.

Last Updated
at string

When was the last update.

Creator ID
creator_id integer

ID of the user who created the client.

External Reference
external_reference string

External reference to the Track Client entity.

Client ID
id integer

Client ID.

Integration External ID
integration_ext_id string

External ID of the linked entity in the external system.

Integration External Type
integration_ext_type string

External type of the linked entity in the external system.

Integration Provider
integration_provider object

Provider that has an entity linked to this Toggl Track entity.

Client Name
name string

Name of the client.

Notes
notes string

Client notes.

Permissions
permissions array of string

List of authorization permissions for this client.

Total Count
total_count integer

Total field to store the total count.

Workspace ID
wid integer

Workspace ID.

Project

Name Path Type Description
Active
active boolean

Whether the project is active or archived.

Actual Hours
actual_hours integer

Actual hours spent on project.

Actual Seconds
actual_seconds integer

Actual seconds spent on project.

Last Updated
at string

Last updated date.

Auto Estimates
auto_estimates boolean

Auto estimates enabled.

Billable
billable boolean

Whether the project is billable.

Can Track Time
can_track_time boolean

Whether time can be tracked to this project.

Client ID (Legacy)
cid integer

Client ID legacy field.

Client ID
client_id integer

Client ID.

Client Name
client_name string

Client name.

Color
color string

Project color.

Created At
created_at string

Creation date.

Currency
currency string

Project currency.

Current Period
current_period object

Current project period, premium feature.

End Date
end_date string

Project end date.

Estimated Hours
estimated_hours integer

Estimated hours for project.

Estimated Seconds
estimated_seconds integer

Estimated seconds for project.

External Reference
external_reference string

External reference to the Track Project Entity.

Fixed Fee
fixed_fee double

Fixed fee, premium feature.

Project ID
id integer

Project ID.

Integration External ID
integration_ext_id string

External ID of the linked entity in the external system.

Integration External Type
integration_ext_type string

External type of the linked entity in the external system.

Integration Provider
integration_provider object

Provider that has an entity linked to this Toggl Track entity.

Is Private
is_private boolean

Whether the project is private.

Project Name
name string

Project name.

Permissions
permissions array of string

Project permissions.

Pinned
pinned boolean

Whether the project is pinned.

Hourly Rate
rate double

Hourly rate for project.

Rate Last Updated
rate_last_updated string

When rate was last updated.

Recurring
recurring boolean

Whether the project is recurring, premium feature.

Recurring Parameters
recurring_parameters array of RecurringParameter

Project recurring parameters, premium feature.

Start Date
start_date string

Project start date.

Status
status string

Status of the project (upcoming, active, ended, archived, deleted).

Template
template boolean

Whether project is a template.

Template ID
template_id integer

Template ID if project is based on template.

Total Count
total_count integer

Total number of projects found.

Workspace ID (Legacy)
wid integer

Workspace ID legacy field.

Workspace ID
workspace_id integer

Workspace ID.

RecurringParameter

Name Path Type Description
Custom Period
custom_period integer

Custom period, used when period field is 'custom'.

Estimated Seconds
estimated_seconds integer

Estimated seconds.

Parameter End Date
parameter_end_date string

Parameter end date.

Parameter Start Date
parameter_start_date string

Recurring start date.

Period
period string

Recurring period.

Project Start Date
project_start_date string

Project start date.

Tag

Name Path Type Description
Last Modified
at string

When was created/last modified.

Creator ID
creator_id integer

ID of the user who created the tag.

Deleted At
deleted_at string

When was deleted.

Tag ID
id integer

Tag ID.

Integration External ID
integration_ext_id string

External ID of the linked entity in the external system.

Integration External Type
integration_ext_type string

External type of the linked entity in the external system.

Integration Provider
integration_provider object

Provider that has an entity linked to this Toggl Track entity.

Tag Name
name string

Tag name.

Permissions
permissions array of string

Tag permissions.

Workspace ID
workspace_id integer

Workspace ID.

Task

Name Path Type Description
Active
active boolean

False when the task has been done.

Last Modified
at string

When the task was created/last modified.

Avatar URL
avatar_url string

Avatar URL.

Client Name
client_name string

Client name.

Estimated Seconds
estimated_seconds integer

Estimated seconds for task.

Task ID
id integer

Task ID.

Integration External ID
integration_ext_id string

External ID of the linked entity in the external system.

Integration External Type
integration_ext_type string

External type of the linked entity in the external system.

Integration Provider
integration_provider object

Provider that has an entity linked to this Toggl Track entity.

Task Name
name string

Task name.

Permissions
permissions array of string

Task permissions.

Project Billable
project_billable boolean

Whether the project is billable.

Project Color
project_color string

Project color metadata.

Project ID
project_id integer

Project ID.

Project Is Private
project_is_private boolean

Whether the project is private.

Project Name
project_name string

Project name.

Rate
rate double

Rate for this task.

Rate Last Updated
rate_last_updated string

When rate was last updated.

Recurring
recurring boolean

Whether this is a recurring task.

Toggl Accounts ID
toggl_accounts_id string

Toggl accounts ID.

Tracked Seconds
tracked_seconds integer

The value tracked_seconds is in milliseconds, not in seconds.

User ID
user_id integer

User ID.

User Name
user_name string

User name.

Workspace ID
workspace_id integer

Workspace ID.

TimeEntry

Name Path Type Description
Last Updated
at string

When was last updated, follows ISO 8601 format.

Billable
billable boolean

Whether the time entry is marked as billable.

Client Name
client_name string

Related entities meta fields.

Description
description string

Time entry description.

Duration
duration integer

Time entry duration. For running entries should be negative, preferable -1.

Duration Only
duronly boolean

Used to create a TE with a duration but without a stop time.

Expense IDs
expense_ids array of integer

Work expenses.

Time Entry ID
id integer

Time Entry ID.

Permissions
permissions array of string

Permission list.

Project ID (Legacy)
pid integer

Project ID, legacy field.

Project Active
project_active boolean

Whether the project is active.

Project Billable
project_billable boolean

Whether the project is billable.

Project Color
project_color string

Project color.

Project ID
project_id integer

Project ID.

Project Name
project_name string

Project name.

Shared With
shared_with array of SharedWith

Indicates who the time entry has been shared with.

Start Time
start string

Start time in UTC.

Stop Time
stop string

Stop time in UTC, can be null if it's still running.

Tag IDs
tag_ids array of integer

Tag IDs, null if tags were not provided or were later deleted.

Tags
tags array of string

Tag names, null if tags were not provided or were later deleted.

Task ID
task_id integer

Task ID.

Task Name
task_name string

Task name.

Task ID (Legacy)
tid integer

Task ID, legacy field.

User ID (Legacy)
uid integer

Time Entry creator ID, legacy field.

User Avatar URL
user_avatar_url string

User avatar URL.

User ID
user_id integer

Time Entry creator ID.

User Name
user_name string

User name.

Workspace ID (Legacy)
wid integer

Workspace ID, legacy field.

Workspace ID
workspace_id integer

Workspace ID.

SharedWith

Name Path Type Description
Accepted
accepted boolean

Whether the share was accepted.

User ID
user_id integer

User ID of person shared with.

User Name
user_name string

User name of person shared with.

Workspace

Name Path Type Description
Active Project Count
active_project_count integer

Number of active projects.

Admin
admin boolean

Current user is workspace admin (Deprecated).

API Token
api_token string

API token (deprecated).

Last Changed
at string

Timestamp of last workspace change.

Business Workspace
business_ws boolean

Workspace on Premium subscription.

CSV Upload
csv_upload object

CSV upload data.

Default Currency
default_currency string

Default currency, premium feature.

Default Hourly Rate
default_hourly_rate double

The default hourly rate, premium feature.

Disable Approvals
disable_approvals boolean

Disable approvals in the workspace.

Disable Timesheet View
disable_timesheet_view boolean

Disable timesheet view in the workspace.

Hide Start End Times
hide_start_end_times boolean

Hide start and end times.

iCal Enabled
ical_enabled boolean

Calendar integration enabled.

iCal URL
ical_url string

URL of calendar.

Workspace ID
id integer

Identifier of the workspace.

Last Modified
last_modified string

Last modification of data in the workspace.

Limit Public Project Data
limit_public_project_data boolean

Limit public projects data in reports to admins.

Logo URL
logo_url string

URL of workspace logo.

Max Data Retention Days
max_data_retention_days object

How far back free workspaces can access data.

Workspace Name
name string

Name of the workspace.

Only Admins May Create Projects
only_admins_may_create_projects boolean

Only admins will be able to create projects.

Only Admins May Create Tags
only_admins_may_create_tags boolean

Only admins will be able to create tags.

Only Admins See Team Dashboard
only_admins_see_team_dashboard boolean

Only admins will be able to see the team dashboard.

Organization ID
organization_id integer

Identifier of the organization.

Permissions
permissions array of string

Permissions list.

Premium
premium boolean

Workspace on Starter subscription.

Projects Billable By Default
projects_billable_by_default boolean

New projects billable by default.

Projects Enforce Billable
projects_enforce_billable boolean

Whether tracking time to projects will enforce billable setting to be respected.

Projects Private By Default
projects_private_by_default boolean

Workspace setting for default project visibility.

Rate Last Updated
rate_last_updated string

Timestamp of last workspace rate update.

Reports Collapse
reports_collapse boolean

Whether reports should be collapsed by default.

Role
role string

Role of the current user in the workspace.

Rounding
rounding integer

Default rounding, premium feature. 0 - nearest, 1 - round up, -1 - round down.

Rounding Minutes
rounding_minutes integer

Default rounding in minutes, premium feature.

Subscription
subscription object

Subscription details (deprecated).

Suspended At
suspended_at string

Timestamp of suspension.

Time Entry Constraints
te_constraints object

Time entry constraints setting.

Working Hours In Minutes
working_hours_in_minutes integer

Working hours in minutes.

Feature

Name Path Type Description
Enabled
enabled boolean

Whether the feature is enabled.

Feature ID
feature_id integer

Feature ID.

Feature Name
name string

Feature name.

WorkspaceFeatures

Name Path Type Description
Features
features array of Feature

List of features.

Workspace ID
workspace_id integer

Workspace ID.

LocationResponse

Name Path Type Description
City
city string

City name.

City Coordinates
city_lat_long string

City latitude and longitude.

Country Code
country_code string

Country code.

Country Name
country_name string

Country name.

State
state string

State or region.

Organization

Name Path Type Description
Admin
admin boolean

Whether the requester is an admin of the organization.

Last Modified
at string

Organization's last modification date.

Created At
created_at string

Organization's creation date.

Organization ID
id integer

Organization ID.

Multi Workspace Enabled
is_multi_workspace_enabled boolean

Is true when the organization option is_multi_workspace_enabled is set.

Is Unified
is_unified boolean

Is unified organization.

Max Data Retention Days
max_data_retention_days object

How far back free workspaces in this org can access data.

Max Workspaces
max_workspaces integer

Maximum number of workspaces allowed for the organization.

Organization Name
name string

Organization Name.

Owner
owner boolean

Whether the requester is a the owner of the organization.

Permissions
permissions array of string

Organization permissions.

Pricing Plan Enterprise
pricing_plan_enterprise boolean

The subscription plan is an enterprise plan.

Pricing Plan ID
pricing_plan_id integer

Organization plan ID.

Pricing Plan Name
pricing_plan_name string

The subscription plan name the org is currently on.

Suspended At
suspended_at string

Whether the organization is currently suspended.

trial_info
trial_info TrialInfo
User Count
user_count integer

Number of organization users.

TrialInfo

Name Path Type Description
Can Have Trial
can_have_trial boolean

Is true if neither the organization nor the owner has never had a trial before.

Last Pricing Plan ID
last_pricing_plan_id integer

Last pricing plan ID.

Next Payment Date
next_payment_date string

Next payment date.

Trial
trial boolean

Whether the organization's subscription is currently on trial.

Trial Available
trial_available boolean

When a trial is available for this organization (Deprecated).

Trial End Date
trial_end_date string

Trial end date.

Trial Plan ID
trial_plan_id integer

Trial plan ID.

TrackReminder

Name Path Type Description
Created At
created_at string

Reminder creation time.

Frequency
frequency integer

Frequency of the reminder in days, should be either 1 or 7.

Group IDs
group_ids array of integer

Groups IDs to send the reminder to.

Reminder ID
reminder_id integer

Reminder ID.

Threshold
threshold integer

Threshold is the number of hours after which the reminder will be sent.

User IDs
user_ids array of integer

User IDs to send the reminder to.

Workspace ID
workspace_id integer

Workspace ID.

TrackRemindersResponse

Name Path Type Description
Track Reminders
items array of TrackReminder

Returns a list of track reminders.

BulkEditResponse

Name Path Type Description
Failures
failure array of BulkEditFailure

List of failed operations.

Success IDs
success array of integer

The IDs for which the patch was successful.

BulkEditFailure

Name Path Type Description
Failed ID
id integer

The ID for which the patch operation failed.

Error Message
message string

The operation failure reason.

WorkspaceUser

Name Path Type Description
2FA Enabled
2fa_enabled boolean

Flag indicating whether use has 2FA enabled or not.

Active
active boolean

Flag indicating if user accepted the invitation.

Admin
admin boolean

Flag indicating if user is admin.

Last Updated
at string

Timestamp of the last update.

Avatar URL
avatar_file_name string

URL of avatar.

Email
email string

Email of the user.

Group IDs
group_ids array of integer

List of groups the user belongs to.

User Workspace ID
id integer

Identifier of the user workspace.

Inactive
inactive boolean

Flag indicating if user was deactivated by admin of the workspace.

Invitation Code
invitation_code string

Internal invitation code.

Invite URL
invite_url string

Internal invite URL.

Is Direct Member
is_direct boolean

Flag indicating if user is a direct member of the workspace (is not assigned to the workspace using the group).

Labor Cost
labor_cost double

Labor cost assigned to the user.

Labor Cost Last Updated
labor_cost_last_updated string

Timestamp of the last labor cost update.

Name
name string

Name of the user.

Organization Admin
organization_admin boolean

Flag indicating if user is admin inside organization.

Rate
rate double

Rate assigned to the user.

Rate Last Updated
rate_last_updated string

Timestamp of the last rate update.

Role
role string

Role of the user.

Role ID
role_id integer

Role ID.

Timezone
timezone string

Timezone of the user.

Global User ID
uid integer

Global user identifier.

User ID
user_id integer

UserID alternative JSON field, only used by get-organization-workspaces-workspaceusers.

View Edit Billable Rates
view_edit_billable_rates boolean

Granular rate permission flags. Only takes effect on roles with conditional rate permissions.

View Edit Labor Costs
view_edit_labor_costs boolean

View edit labor costs permission.

Workspace ID
wid integer

Workspace identifier.

Working Hours in Minutes
working_hours_in_minutes integer

Working hours value in minutes.

Workspace Admin
workspace_admin boolean

Flag indicating if user is admin inside workspace.

Workspace ID
workspace_id integer

UserID alternative JSON field, only used by get-organization-workspaces-workspaceusers.

Rate

Name Path Type Description
Amount
amount double

Amount of the rate.

Created At
created_at string

Creation date of the rate.

Creator ID
creator_id integer

Creator ID.

Deleted At
deleted_at string

Deletion date of the rate, in case that is null it means the rates is active.

End Date
end string

End date time of the rate.

Rate ID
id integer

Identifier of the rate.

Planned Task ID
planned_task_id integer

Planned task ID which the rate is applied.

Project ID
project_id integer

Project ID which the rate is applied.

Project User ID
project_user_id integer

Project user ID which the rate is applied.

Rate Change Mode
rate_change_mode string

Rate change mode.

Start Date
start string

Start date time of the rate.

Type
type string

Rate type.

Updated At
updated_at string

Last update date of the rate.

Workspace ID
workspace_id integer

Workspace ID which the rate is applied.

Workspace User ID
workspace_user_id integer

Workspace user ID which the rate is applied.

WorkspaceStatistics

Name Path Type Description
Admins
admins array of WorkspaceAdmin

List of workspace admins.

Groups Count
groups_count integer

Number of groups in workspace.

Members Count
members_count integer

Number of members in workspace.

WorkspaceAdmin

Name Path Type Description
Name
name string

Admin name.

User ID
user_id integer

Admin user ID.

TimeEntryConstraints

Name Path Type Description
Description Required
description_present boolean

Description is required for time entries.

Project Required
project_present boolean

Project is required for time entries.

Tag Required
tag_present boolean

Tag is required for time entries.

Task Required
task_present boolean

Task is required for time entries.

Constraints Enabled
time_entry_constraints_enabled boolean

Time entry constraints are enabled.

WorkspaceUserSimple

Name Path Type Description
Email
email string

Email of the user.

Full Name
fullname string

Name of the user.

User ID
id integer

Global user identifier.

Inactive
inactive boolean

Inactive indicates if user is deactivated or not in the workspace.

Is Active
is_active boolean

IsActive indicates if user has joined the workspace.

Is Admin (Deprecated)
is_admin boolean

Flag indicating if user is admin (Deprecated).

Role
role string

Role of the user.

ProjectUser

Name Path Type Description
Last Modified
at string

When was last modified.

Group ID (Legacy)
gid integer

Group ID, legacy field.

Group ID
group_id integer

Group ID.

Project User ID
id integer

Project User ID.

Labor Cost
labor_cost double

Labor cost for this project user.

Labor Cost Last Updated
labor_cost_last_updated string

Date for labor cost last updated.

Manager
manager boolean

Whether the user is manager of the project.

Project ID
project_id integer

Project ID.

Rate
rate double

Rate for this project user.

Rate Last Updated
rate_last_updated string

Date for rate last updated.

User ID
user_id integer

User ID.

Workspace ID
workspace_id integer

Workspace ID.

TimeEntryWebhookEvent

Name Path Type Description
Event ID
event_id integer

Unique identifier for the webhook event.

Subscription ID
subscription_id integer

ID of the webhook subscription that triggered this event.

Event Created At
created_at string

When the event was created.

Event Timestamp
timestamp string

When the event was sent.

Creator ID
creator_id integer

ID of the user who triggered the event.

Callback URL
url_callback string

The callback URL for this event.

Request Type
metadata.request_type string

Type of request that triggered the event.

Event User ID
metadata.event_user_id integer

ID of the user associated with the event.

Action
metadata.action string

Action that was performed (created, updated, deleted, started, stopped).

payload
payload TimeEntry