Skip to main content

Workspaces

POST Create a new workspace.

https://api.track.toggl.com/api/v9/organizations/{organization_id}/workspaces

Create a workspace within an existing organization.

curl -X POST https://api.track.toggl.com/api/v9/organizations/{organization_id}/workspaces \
-H "Content-Type: application/json" \
-d '{"default_currency":"string","initial_pricing_plan":"integer","name":"string","only_admins_may_create_projects":"boolean","only_admins_may_create_tags":"boolean","only_admins_see_billable_rates":"boolean","only_admins_see_team_dashboard":"boolean","organizationID":"integer","projects_billable_by_default":"boolean","rate_change_mode":"string","reports_collapse":"boolean","rounding":"integer","rounding_minutes":"integer"}' \
-u <email>:<password>

Parameters

Path

nametyperequireddescription
organization_idintegertrueNumeric ID of the organization

Body

nametyperequireddescription
adminsundefinedfalse-
default_currencystringfalse-
initial_pricing_planintegerfalse-
namestringfalse-
only_admins_may_create_projectsbooleanfalse-
only_admins_may_create_tagsbooleanfalse-
only_admins_see_billable_ratesbooleanfalse-
only_admins_see_team_dashboardbooleanfalse-
organizationIDintegerfalse-
projects_billable_by_defaultbooleanfalse-
rate_change_modestringfalse-
reports_collapsebooleanfalse-
roundingintegerfalse-
rounding_minutesintegerfalse-

Response

{"admin":{"type":"boolean"},"api_token":{"type":"string"},"at":{"type":"string"},"business_ws":{"type":"boolean"},"csv_upload":{"at":{"type":"string"},"log_id":{"type":"integer"}},"default_currency":{"type":"string"},"ical_enabled":{"type":"boolean"},"ical_url":{"type":"string"},"id":{"type":"integer"},"logo_url":{"type":"string"},"name":{"type":"string"},"only_admins_may_create_projects":{"type":"boolean"},"only_admins_may_create_tags":{"type":"boolean"},"only_admins_see_billable_rates":{"type":"boolean"},"only_admins_see_team_dashboard":{"type":"boolean"},"organization_id":{"type":"integer"},"premium":{"type":"boolean"},"profile":{"type":"integer"},"projects_billable_by_default":{"type":"boolean"},"rate_last_updated":{"type":"string"},"reports_collapse":{"type":"boolean"},"rounding":{"type":"integer"},"rounding_minutes":{"type":"integer"},"server_deleted_at":{"type":"string","format":"date-time"},"subscription":{"auto_renew":{"type":"boolean"},"card_details":{"added_at":{"type":"string"},"card_number":{"type":"string"},"card_type":{"type":"string"},"creator_id":{"type":"integer"},"creator_name":{"type":"string"},"expiry_date":{"type":"string"},"holder_name":{"type":"string"}},"company_id":{"type":"integer"},"contact_detail":{"company_address":{"type":"string"},"company_city":{"type":"string"},"company_name":{"type":"string"},"contact_detail_id":{"type":"integer"},"contact_email":{"type":"string"},"contact_person":{"type":"string"},"country_id":{"type":"integer"},"country_subdivision_id":{"type":"integer"},"created_at":{"type":"string"},"customer_id":{"type":"integer"},"is_eu_resident":{"type":"boolean"},"updated_at":{"type":"string"},"user_id":{"type":"integer"},"vat_number":{"type":"string"},"vat_number_valid":{"description":"DEPRECATED","type":"boolean"},"vat_number_validated_at":{"description":"DEPRECATED","type":"string"},"zip_code":{"type":"string"}},"created_at":{"type":"string","format":"date-time"},"currency":{"type":"string"},"customer_id":{"type":"integer"},"deleted_at":{"type":"string","format":"date-time"},"last_pricing_plan_id":{"type":"integer"},"organization_id":{"type":"integer"},"payment_details":{"created_at":{"type":"string"},"currency":{"type":"string"},"customer_id":{"type":"integer"},"payment_type":{"type":"string"},"reference":{"type":"string"},"user_id":{"type":"integer"}},"pricing_plan_id":{"type":"integer"},"renewal_at":{"type":"string","format":"date-time"},"subscription_id":{"type":"integer"},"subscription_period":{"created_at":{"type":"string"},"finished_on":{"type":"string"},"started_on":{"type":"string"},"subscription_id":{"type":"integer"},"subscription_period_id":{"type":"integer"},"trial":{"type":"boolean"},"user_count":{"type":"integer"}},"workspace_id":{"type":"integer"}},"suspended_at":{"type":"string","format":"date-time"},"te_constraints":{"description_present":{"type":"boolean"},"project_present":{"type":"boolean"},"tag_present":{"type":"boolean"},"task_present":{"type":"boolean"},"time_entry_constraints_enabled":{"type":"boolean"}}}

GET List of users who belong to the given workspace.

https://api.track.toggl.com/api/v9/organizations/{organization_id}/workspaces/{workspace_id}/workspace_users

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

curl  https://api.track.toggl.com/api/v9/organizations/{organization_id}/workspaces/{workspace_id}/workspace_users \
-H "Content-Type: application/json" \
-u <email>:<password>

Parameters

Path

nametyperequireddescription
organization_idintegertrueNumeric ID of the organization
workspace_idintegertrueNumeric ID of the workspace within the organization

Response

Successful operation

PATCH Changes the users in a workspace.

https://api.track.toggl.com/api/v9/organizations/{organization_id}/workspaces/{workspace_id}/workspace_users

Changes the users in a workspace (currently deletion only).

curl -X PATCH https://api.track.toggl.com/api/v9/organizations/{organization_id}/workspaces/{workspace_id}/workspace_users \
-H "Content-Type: application/json" \
-d '{}' \
-u <email>:<password>

Parameters

Path

nametyperequireddescription
organization_idintegertrueNumeric ID of the organization
workspace_idintegertrueNumeric ID of the workspace

Body

nametyperequireddescription
deleteundefinedfalse-

Response

Successful operation.

POST Workspaces

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

Change a workspace.

curl -X POST https://api.track.toggl.com/api/v9/workspaces \
-H "Content-Type: application/json" \
-d '{"default_currency":"string","initial_pricing_plan":"integer","name":"string","only_admins_may_create_projects":"boolean","only_admins_may_create_tags":"boolean","only_admins_see_billable_rates":"boolean","only_admins_see_team_dashboard":"boolean","organizationID":"integer","projects_billable_by_default":"boolean","rate_change_mode":"string","reports_collapse":"boolean","rounding":"integer","rounding_minutes":"integer"}' \
-u <email>:<password>

Parameters

Body

nametyperequireddescription
adminsundefinedfalse-
default_currencystringfalse-
initial_pricing_planintegerfalse-
namestringfalse-
only_admins_may_create_projectsbooleanfalse-
only_admins_may_create_tagsbooleanfalse-
only_admins_see_billable_ratesbooleanfalse-
only_admins_see_team_dashboardbooleanfalse-
organizationIDintegerfalse-
projects_billable_by_defaultbooleanfalse-
rate_change_modestringfalse-
reports_collapsebooleanfalse-
roundingintegerfalse-
rounding_minutesintegerfalse-

Response

{"admin":{"type":"boolean"},"api_token":{"type":"string"},"at":{"type":"string"},"business_ws":{"type":"boolean"},"csv_upload":{"at":{"type":"string"},"log_id":{"type":"integer"}},"default_currency":{"type":"string"},"ical_enabled":{"type":"boolean"},"ical_url":{"type":"string"},"id":{"type":"integer"},"logo_url":{"type":"string"},"name":{"type":"string"},"only_admins_may_create_projects":{"type":"boolean"},"only_admins_may_create_tags":{"type":"boolean"},"only_admins_see_billable_rates":{"type":"boolean"},"only_admins_see_team_dashboard":{"type":"boolean"},"organization_id":{"type":"integer"},"premium":{"type":"boolean"},"profile":{"type":"integer"},"projects_billable_by_default":{"type":"boolean"},"rate_last_updated":{"type":"string"},"reports_collapse":{"type":"boolean"},"rounding":{"type":"integer"},"rounding_minutes":{"type":"integer"},"server_deleted_at":{"type":"string","format":"date-time"},"subscription":{"auto_renew":{"type":"boolean"},"card_details":{"added_at":{"type":"string"},"card_number":{"type":"string"},"card_type":{"type":"string"},"creator_id":{"type":"integer"},"creator_name":{"type":"string"},"expiry_date":{"type":"string"},"holder_name":{"type":"string"}},"company_id":{"type":"integer"},"contact_detail":{"company_address":{"type":"string"},"company_city":{"type":"string"},"company_name":{"type":"string"},"contact_detail_id":{"type":"integer"},"contact_email":{"type":"string"},"contact_person":{"type":"string"},"country_id":{"type":"integer"},"country_subdivision_id":{"type":"integer"},"created_at":{"type":"string"},"customer_id":{"type":"integer"},"is_eu_resident":{"type":"boolean"},"updated_at":{"type":"string"},"user_id":{"type":"integer"},"vat_number":{"type":"string"},"vat_number_valid":{"description":"DEPRECATED","type":"boolean"},"vat_number_validated_at":{"description":"DEPRECATED","type":"string"},"zip_code":{"type":"string"}},"created_at":{"type":"string","format":"date-time"},"currency":{"type":"string"},"customer_id":{"type":"integer"},"deleted_at":{"type":"string","format":"date-time"},"last_pricing_plan_id":{"type":"integer"},"organization_id":{"type":"integer"},"payment_details":{"created_at":{"type":"string"},"currency":{"type":"string"},"customer_id":{"type":"integer"},"payment_type":{"type":"string"},"reference":{"type":"string"},"user_id":{"type":"integer"}},"pricing_plan_id":{"type":"integer"},"renewal_at":{"type":"string","format":"date-time"},"subscription_id":{"type":"integer"},"subscription_period":{"created_at":{"type":"string"},"finished_on":{"type":"string"},"started_on":{"type":"string"},"subscription_id":{"type":"integer"},"subscription_period_id":{"type":"integer"},"trial":{"type":"boolean"},"user_count":{"type":"integer"}},"workspace_id":{"type":"integer"}},"suspended_at":{"type":"string","format":"date-time"},"te_constraints":{"description_present":{"type":"boolean"},"project_present":{"type":"boolean"},"tag_present":{"type":"boolean"},"task_present":{"type":"boolean"},"time_entry_constraints_enabled":{"type":"boolean"}}}

GET Get single workspace

https://api.track.toggl.com/api/v9/workspaces/{workspace_id}

Get information of single workspace.

curl  https://api.track.toggl.com/api/v9/workspaces/{workspace_id} \
-H "Content-Type: application/json" \
-u <email>:<password>

Parameters

Path

nametyperequireddescription
workspace_idintegertrueNumeric Workspace ID

Response

{"admin":{"type":"boolean"},"api_token":{"type":"string"},"at":{"type":"string"},"business_ws":{"type":"boolean"},"csv_upload":{"at":{"type":"string"},"log_id":{"type":"integer"}},"default_currency":{"type":"string"},"ical_enabled":{"type":"boolean"},"ical_url":{"type":"string"},"id":{"type":"integer"},"logo_url":{"type":"string"},"name":{"type":"string"},"only_admins_may_create_projects":{"type":"boolean"},"only_admins_may_create_tags":{"type":"boolean"},"only_admins_see_billable_rates":{"type":"boolean"},"only_admins_see_team_dashboard":{"type":"boolean"},"organization_id":{"type":"integer"},"premium":{"type":"boolean"},"profile":{"type":"integer"},"projects_billable_by_default":{"type":"boolean"},"rate_last_updated":{"type":"string"},"reports_collapse":{"type":"boolean"},"rounding":{"type":"integer"},"rounding_minutes":{"type":"integer"},"server_deleted_at":{"type":"string","format":"date-time"},"subscription":{"auto_renew":{"type":"boolean"},"card_details":{"added_at":{"type":"string"},"card_number":{"type":"string"},"card_type":{"type":"string"},"creator_id":{"type":"integer"},"creator_name":{"type":"string"},"expiry_date":{"type":"string"},"holder_name":{"type":"string"}},"company_id":{"type":"integer"},"contact_detail":{"company_address":{"type":"string"},"company_city":{"type":"string"},"company_name":{"type":"string"},"contact_detail_id":{"type":"integer"},"contact_email":{"type":"string"},"contact_person":{"type":"string"},"country_id":{"type":"integer"},"country_subdivision_id":{"type":"integer"},"created_at":{"type":"string"},"customer_id":{"type":"integer"},"is_eu_resident":{"type":"boolean"},"updated_at":{"type":"string"},"user_id":{"type":"integer"},"vat_number":{"type":"string"},"vat_number_valid":{"description":"DEPRECATED","type":"boolean"},"vat_number_validated_at":{"description":"DEPRECATED","type":"string"},"zip_code":{"type":"string"}},"created_at":{"type":"string","format":"date-time"},"currency":{"type":"string"},"customer_id":{"type":"integer"},"deleted_at":{"type":"string","format":"date-time"},"last_pricing_plan_id":{"type":"integer"},"organization_id":{"type":"integer"},"payment_details":{"created_at":{"type":"string"},"currency":{"type":"string"},"customer_id":{"type":"integer"},"payment_type":{"type":"string"},"reference":{"type":"string"},"user_id":{"type":"integer"}},"pricing_plan_id":{"type":"integer"},"renewal_at":{"type":"string","format":"date-time"},"subscription_id":{"type":"integer"},"subscription_period":{"created_at":{"type":"string"},"finished_on":{"type":"string"},"started_on":{"type":"string"},"subscription_id":{"type":"integer"},"subscription_period_id":{"type":"integer"},"trial":{"type":"boolean"},"user_count":{"type":"integer"}},"workspace_id":{"type":"integer"}},"suspended_at":{"type":"string","format":"date-time"},"te_constraints":{"description_present":{"type":"boolean"},"project_present":{"type":"boolean"},"tag_present":{"type":"boolean"},"task_present":{"type":"boolean"},"time_entry_constraints_enabled":{"type":"boolean"}}}

PUT Update workspace

https://api.track.toggl.com/api/v9/workspaces/{workspace_id}

Update a specific workspace.

curl -X PUT https://api.track.toggl.com/api/v9/workspaces/{workspace_id} \
-H "Content-Type: application/json" \
-d '{"default_currency":"string","initial_pricing_plan":"integer","name":"string","only_admins_may_create_projects":"boolean","only_admins_may_create_tags":"boolean","only_admins_see_billable_rates":"boolean","only_admins_see_team_dashboard":"boolean","organizationID":"integer","projects_billable_by_default":"boolean","rate_change_mode":"string","reports_collapse":"boolean","rounding":"integer","rounding_minutes":"integer"}' \
-u <email>:<password>

Parameters

Path

nametyperequireddescription
workspace_idintegertrueNumeric Workspace ID

Body

nametyperequireddescription
adminsundefinedfalse-
default_currencystringfalse-
initial_pricing_planintegerfalse-
namestringfalse-
only_admins_may_create_projectsbooleanfalse-
only_admins_may_create_tagsbooleanfalse-
only_admins_see_billable_ratesbooleanfalse-
only_admins_see_team_dashboardbooleanfalse-
organizationIDintegerfalse-
projects_billable_by_defaultbooleanfalse-
rate_change_modestringfalse-
reports_collapsebooleanfalse-
roundingintegerfalse-
rounding_minutesintegerfalse-

Response

{"admin":{"type":"boolean"},"api_token":{"type":"string"},"at":{"type":"string"},"business_ws":{"type":"boolean"},"csv_upload":{"at":{"type":"string"},"log_id":{"type":"integer"}},"default_currency":{"type":"string"},"ical_enabled":{"type":"boolean"},"ical_url":{"type":"string"},"id":{"type":"integer"},"logo_url":{"type":"string"},"name":{"type":"string"},"only_admins_may_create_projects":{"type":"boolean"},"only_admins_may_create_tags":{"type":"boolean"},"only_admins_see_billable_rates":{"type":"boolean"},"only_admins_see_team_dashboard":{"type":"boolean"},"organization_id":{"type":"integer"},"premium":{"type":"boolean"},"profile":{"type":"integer"},"projects_billable_by_default":{"type":"boolean"},"rate_last_updated":{"type":"string"},"reports_collapse":{"type":"boolean"},"rounding":{"type":"integer"},"rounding_minutes":{"type":"integer"},"server_deleted_at":{"type":"string","format":"date-time"},"subscription":{"auto_renew":{"type":"boolean"},"card_details":{"added_at":{"type":"string"},"card_number":{"type":"string"},"card_type":{"type":"string"},"creator_id":{"type":"integer"},"creator_name":{"type":"string"},"expiry_date":{"type":"string"},"holder_name":{"type":"string"}},"company_id":{"type":"integer"},"contact_detail":{"company_address":{"type":"string"},"company_city":{"type":"string"},"company_name":{"type":"string"},"contact_detail_id":{"type":"integer"},"contact_email":{"type":"string"},"contact_person":{"type":"string"},"country_id":{"type":"integer"},"country_subdivision_id":{"type":"integer"},"created_at":{"type":"string"},"customer_id":{"type":"integer"},"is_eu_resident":{"type":"boolean"},"updated_at":{"type":"string"},"user_id":{"type":"integer"},"vat_number":{"type":"string"},"vat_number_valid":{"description":"DEPRECATED","type":"boolean"},"vat_number_validated_at":{"description":"DEPRECATED","type":"string"},"zip_code":{"type":"string"}},"created_at":{"type":"string","format":"date-time"},"currency":{"type":"string"},"customer_id":{"type":"integer"},"deleted_at":{"type":"string","format":"date-time"},"last_pricing_plan_id":{"type":"integer"},"organization_id":{"type":"integer"},"payment_details":{"created_at":{"type":"string"},"currency":{"type":"string"},"customer_id":{"type":"integer"},"payment_type":{"type":"string"},"reference":{"type":"string"},"user_id":{"type":"integer"}},"pricing_plan_id":{"type":"integer"},"renewal_at":{"type":"string","format":"date-time"},"subscription_id":{"type":"integer"},"subscription_period":{"created_at":{"type":"string"},"finished_on":{"type":"string"},"started_on":{"type":"string"},"subscription_id":{"type":"integer"},"subscription_period_id":{"type":"integer"},"trial":{"type":"boolean"},"user_count":{"type":"integer"}},"workspace_id":{"type":"integer"}},"suspended_at":{"type":"string","format":"date-time"},"te_constraints":{"description_present":{"type":"boolean"},"project_present":{"type":"boolean"},"tag_present":{"type":"boolean"},"task_present":{"type":"boolean"},"time_entry_constraints_enabled":{"type":"boolean"}}}

GET Workspace statistics

https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/statistics

Returns workspace admins list, members count and groups count

curl  https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/statistics \
-H "Content-Type: application/json" \
-u <email>:<password>

Response

{"admins":{},"groups_count":{"type":"integer"},"members_count":{"type":"integer"}}

GET TrackReminders

https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/track_reminders

Returns a list of track reminders.

curl  https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/track_reminders \
-H "Content-Type: application/json" \
-u <email>:<password>

Parameters

Path

nametyperequireddescription
workspace_idintegertrueNumeric ID of the workspace

Response

Returns a list of track reminders.

POST TrackReminders

https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/track_reminders

Creates a workspace tracking reminder.

curl -X POST https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/track_reminders \
-H "Content-Type: application/json" \
-d '{"frequency":"integer"}' \
-u <email>:<password>

Parameters

Path

nametyperequireddescription
workspace_idintegertrueNumeric ID of the workspace

Body

nametyperequireddescription
frequencyintegerfalse-
group_idsundefinedfalse-
user_idsundefinedfalse-

Response

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

PUT TrackReminder

https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/track_reminders/{reminder_id}

Updates a workspace tracking reminder.

curl -X PUT https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/track_reminders/{reminder_id} \
-H "Content-Type: application/json" \
-d '{"frequency":"integer"}' \
-u <email>:<password>

Parameters

Path

nametyperequireddescription
workspace_idintegertrueNumeric ID of the workspace
reminder_idintegertrueReminder ID.

Body

nametyperequireddescription
frequencyintegerfalse-
group_idsundefinedfalse-
user_idsundefinedfalse-

Response

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

DELETE TrackReminder

https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/track_reminders/{reminder_id}

Deletes a workspace tracking reminder.

curl -X DELETE https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/track_reminders/{reminder_id} \
-H "Content-Type: application/json" \
-u <email>:<password>

Parameters

Path

nametyperequireddescription
workspace_idintegertrueNumeric ID of the workspace
reminder_idintegertrueReminder ID.

Response

Returns only status code.
© 2022 Toggl. All rights reserved.