Skip to main content

Projects

GET Get workspace projects users

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

List all projects users for a given workspace.

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

Parameters

Path

nametyperequireddescription
workspace_idintegertrueNumeric ID of the workspace

Response

Successful operation.

POST Add an user into workspace projects users

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

Include a project user for a given workspace.

curl -X POST https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/project_users \
-H "Content-Type: application/json" \
-d '{"labour_cost":"integer","manager":"boolean","project_id":"integer","rate_change_mode":"string","user_id":"integer"}' \
-u <email>:<password>

Parameters

Path

nametyperequireddescription
workspace_idintegertrueNumeric ID of the workspace

Body

nametyperequireddescription
labour_costintegerfalse-
managerbooleanfalse-
postedFieldsundefinedfalse-
project_idintegerfalse-
rate_change_modestringfalse-
user_idintegerfalse-

Response

{"at":{"type":"string"},"gid":{"type":"integer"},"group_id":{"type":"integer"},"id":{"type":"integer"},"labour_cost":{"type":"integer"},"manager":{"type":"boolean"},"project_id":{"type":"integer"},"rate_last_updated":{"type":"string"},"user_id":{"type":"integer"},"workspace_id":{"type":"integer"}}

PATCH Patch project users from workspace

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

Patch a list of project users for a given workspace.

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

Parameters

Path

nametyperequireddescription
workspace_idintegertrueNumeric ID of the workspace

Query

nametyperequireddescription
project_user_idsarraytrueNumeric IDs of the project users

Response

Successful operation.

PUT Update an user into workspace projects users

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

Update the data for a project user for a given workspace.

curl -X PUT https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/project_users/{project_user_id} \
-H "Content-Type: application/json" \
-d '{"labour_cost":"integer","manager":"boolean","rate_change_mode":"string"}' \
-u <email>:<password>

Parameters

Path

nametyperequireddescription
workspace_idintegertrueNumeric ID of the workspace
project_user_idintegertrueNumeric ID of the project user

Body

nametyperequireddescription
labour_costintegerfalse-
managerbooleanfalse-
postedFieldsundefinedfalse-
rate_change_modestringfalse-

Response

{"at":{"type":"string"},"gid":{"type":"integer"},"group_id":{"type":"integer"},"id":{"type":"integer"},"labour_cost":{"type":"integer"},"manager":{"type":"boolean"},"project_id":{"type":"integer"},"rate_last_updated":{"type":"string"},"user_id":{"type":"integer"},"workspace_id":{"type":"integer"}}

DELETE Delete a project user from workspace projects users

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

Delete a project user for a given workspace.

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

Parameters

Path

nametyperequireddescription
workspace_idintegertrueNumeric ID of the workspace
project_user_idintegertrueNumeric ID of the project user

Response

Successful operation.

GET WorkspaceProjects

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

Get projects for given workspace.

curl  https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/projects \
-H "Content-Type: application/json" \
-d '{"active":"boolean","billable":"boolean","name":"string","onlyTemplates":"boolean","page":"integer","perPage":"integer","since":"integer","sortField":"string","sortOrder":"string","uid":"integer","wid":"integer"}' \
-u <email>:<password>

Parameters

Path

nametyperequireddescription
workspace_idintegertrueNumeric ID of the workspace

Body

nametyperequireddescription
activebooleanfalse-
billablebooleanfalse-
clientIdsundefinedfalse-
groupIdsundefinedfalse-
namestringfalse-
onlyTemplatesbooleanfalse-
pageintegerfalse-
perPageintegerfalse-
sinceintegerfalse-
sortFieldstringfalse-
sortOrderstringfalse-
uidintegerfalse-
userIdsundefinedfalse-
widintegerfalse-

Response

Successful operation.

POST WorkspaceProjects

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

Create project for given workspace.

curl -X POST https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/projects \
-H "Content-Type: application/json" \
-d '{"active":"boolean","auto_estimates":"boolean","billable":"Pro features","cid":"Ideally we want object_id type fields, so yeah, those here are for
that and proper field as priority, hence if that set, we use that","client_id":"integer","client_name":"string","color":"string","currency":"string","estimated_hours":"integer","foreign_id":"End pro features
Pipes helper","is_private":"boolean","name":"string","rate_change_mode":"string","recurring":"boolean","template":"boolean","template_id":"integer"}' \
-u <email>:<password>

Parameters

Path

nametyperequireddescription
workspace_idintegertrueNumeric ID of the workspace

Body

nametyperequireddescription
activebooleanfalse-
auto_estimatesbooleanfalse-
billablebooleanfalsePro features
cidintegerfalseIdeally we want object_id type fields, so yeah, those here are for that and proper field as priority, hence if that set, we use that
client_idintegerfalse-
client_namestringfalse-
colorstringfalse-
currencystringfalse-
estimated_hoursintegerfalse-
foreign_idstringfalseEnd pro features Pipes helper
is_privatebooleanfalse-
namestringfalse-
postedFieldsundefinedfalse-
rate_change_modestringfalse-
recurringbooleanfalse-
recurring_parametersundefinedfalse-
templatebooleanfalse-
template_idintegerfalse-

Response

{"active":{"type":"boolean"},"actual_hours":{"description":"End pro features","type":"integer"},"at":{"type":"string"},"auto_estimates":{"type":"boolean"},"billable":{"description":"Pro features","type":"boolean"},"cid":{"type":"integer"},"client_id":{"type":"integer"},"color":{"type":"string"},"created_at":{"type":"string"},"currency":{"type":"string"},"current_period":{"end_date":{"type":"string"},"start_date":{"type":"string"}},"estimated_hours":{"type":"integer"},"foreign_id":{"description":"ForeignID - meta information for pipes, it should not be saved into DB!","type":"string"},"id":{"type":"integer"},"is_private":{"type":"boolean"},"name":{"type":"string"},"rate_last_updated":{"type":"string"},"recurring":{"type":"boolean"},"recurring_parameters":{},"server_deleted_at":{"type":"string"},"template":{"type":"boolean"},"wid":{"description":"Ideally we'd want object_id type things, but for usual reasons we need to keep both around, so, that's that","type":"integer"},"workspace_id":{"type":"integer"}}

PATCH WorkspaceProjects

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

Bulk editing workspace projects.

curl -X PATCH https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/projects/{project_ids} \
-H "Content-Type: application/json" \
-d '{"op":"string","path":"string"}' \
-u <email>:<password>

Parameters

Path

nametyperequireddescription
workspace_idintegertrueNumeric ID of the workspace
project_idsstringtrueNumeric IDs of project ids, separated by comma. E.g.: 204301830,202700150,202687559

Body

nametyperequireddescription
opstringfalse-
pathstringfalse-

Response

{"failure":{},"success":{}}

GET WorkspaceProject

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

Get project for given workspace.

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

Parameters

Path

nametyperequireddescription
workspace_idintegertrueNumeric ID of the workspace
project_idintegertrueNumeric ID of the project

Response

{"active":{"type":"boolean"},"actual_hours":{"description":"End pro features","type":"integer"},"at":{"type":"string"},"auto_estimates":{"type":"boolean"},"billable":{"description":"Pro features","type":"boolean"},"cid":{"type":"integer"},"client_id":{"type":"integer"},"color":{"type":"string"},"created_at":{"type":"string"},"currency":{"type":"string"},"current_period":{"end_date":{"type":"string"},"start_date":{"type":"string"}},"estimated_hours":{"type":"integer"},"foreign_id":{"description":"ForeignID - meta information for pipes, it should not be saved into DB!","type":"string"},"id":{"type":"integer"},"is_private":{"type":"boolean"},"name":{"type":"string"},"rate_last_updated":{"type":"string"},"recurring":{"type":"boolean"},"recurring_parameters":{},"server_deleted_at":{"type":"string"},"template":{"type":"boolean"},"wid":{"description":"Ideally we'd want object_id type things, but for usual reasons we need to keep both around, so, that's that","type":"integer"},"workspace_id":{"type":"integer"}}

POST WorkspaceProject

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

Post project for given workspace.

curl -X POST https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/projects/{project_id} \
-H "Content-Type: application/json" \
-d '{"active":"boolean","auto_estimates":"boolean","billable":"Pro features","cid":"Ideally we want object_id type fields, so yeah, those here are for
that and proper field as priority, hence if that set, we use that","client_id":"integer","client_name":"string","color":"string","currency":"string","estimated_hours":"integer","foreign_id":"End pro features
Pipes helper","is_private":"boolean","name":"string","rate_change_mode":"string","recurring":"boolean","template":"boolean","template_id":"integer"}' \
-u <email>:<password>

Parameters

Path

nametyperequireddescription
workspace_idintegertrueNumeric ID of the workspace
project_idintegertrueNumeric ID of the project

Body

nametyperequireddescription
activebooleanfalse-
auto_estimatesbooleanfalse-
billablebooleanfalsePro features
cidintegerfalseIdeally we want object_id type fields, so yeah, those here are for that and proper field as priority, hence if that set, we use that
client_idintegerfalse-
client_namestringfalse-
colorstringfalse-
currencystringfalse-
estimated_hoursintegerfalse-
foreign_idstringfalseEnd pro features Pipes helper
is_privatebooleanfalse-
namestringfalse-
postedFieldsundefinedfalse-
rate_change_modestringfalse-
recurringbooleanfalse-
recurring_parametersundefinedfalse-
templatebooleanfalse-
template_idintegerfalse-

Response

{"active":{"type":"boolean"},"actual_hours":{"description":"End pro features","type":"integer"},"at":{"type":"string"},"auto_estimates":{"type":"boolean"},"billable":{"description":"Pro features","type":"boolean"},"cid":{"type":"integer"},"client_id":{"type":"integer"},"color":{"type":"string"},"created_at":{"type":"string"},"currency":{"type":"string"},"current_period":{"end_date":{"type":"string"},"start_date":{"type":"string"}},"estimated_hours":{"type":"integer"},"foreign_id":{"description":"ForeignID - meta information for pipes, it should not be saved into DB!","type":"string"},"id":{"type":"integer"},"is_private":{"type":"boolean"},"name":{"type":"string"},"rate_last_updated":{"type":"string"},"recurring":{"type":"boolean"},"recurring_parameters":{},"server_deleted_at":{"type":"string"},"template":{"type":"boolean"},"wid":{"description":"Ideally we'd want object_id type things, but for usual reasons we need to keep both around, so, that's that","type":"integer"},"workspace_id":{"type":"integer"}}

DELETE WorkspaceProject

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

Delete project for given workspace.

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

Parameters

Path

nametyperequireddescription
workspace_idintegertrueNumeric ID of the workspace
project_idintegertrueNumeric ID of the project

Response

Successful operation.
© 2022 Toggl. All rights reserved.