Skip to main content

Utils

POST List clients​

https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/filters/clients

Returns filtered clients from a workspace (only ID and name).

curl -X POST https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/filters/clients \
-H "Content-Type: application/json" \
-d '{"ids":["integer"],"name":"string","start":"integer"}' \
-u <email>:<password>

Parameters​

Path​

nametyperequireddescription
workspace_idintegertrueWorkspace ID

Body​

nametypedescription
idsArray of integer-
namestring-
startinteger-

Response​

200​

Returns filtered clients

Array of:

nametypedescription
idinteger-
namestring-

400​

Maximum count of posted IDs is 2000

403​

Workspace not found/accessible

500​

Internal Server Error

POST List project groups filter​

https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/filters/project_groups

Returns the project groups from a workspace.

curl -X POST https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/filters/project_groups \
-H "Content-Type: application/json" \
-d '{"group_ids":["integer"],"project_ids":["integer"],"start_id":"integer"}' \
-u <email>:<password>

Parameters​

Path​

nametyperequireddescription
workspace_idintegertrueWorkspace ID

Body​

nametypedescription
group_idsArray of integerGroup IDs, optional. At least Projects IDs or Group IDs should be informed.
project_idsArray of integerProject IDs, optional. At least Projects IDs or Group IDs should be informed.
start_idinteger-

Response​

200​

Returns project groups

Array of:

nametypedescription
group_idinteger-
idinteger-
namestring-
project_idinteger-

400​

Possible error messages:

* At least one parameter must be set
* Maximum count of posted IDs is {value}

403​

Workspace not found/accessible

500​

Internal Server Error

POST List project users​

https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/filters/project_users

Returns filtered user projects.

curl -X POST https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/filters/project_users \
-H "Content-Type: application/json" \
-d '{"client_ids":["integer"],"project_ids":["integer"],"start_id":"integer"}' \
-u <email>:<password>

Parameters​

Path​

nametyperequireddescription
workspace_idintegertrueWorkspace ID

Body​

nametypedescription
client_idsArray of integerClient IDs, optional.
project_idsArray of integerProject IDs, optional.
start_idinteger-

Response​

200​

Returns user projects

Array of:

nametypedescription
group_idinteger-
hourly_ratenumber-
idinteger-
labour_costinteger-
managerboolean-
project_idinteger-
user_idinteger-

400​

Possible error messages:

* At least one parameter must be set
* Maximum count of posted IDs is {value}

403​

Workspace not found/accessible

500​

Internal Server Error

POST List projects​

https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/filters/projects

Returns filtered projects from a workspace.

curl -X POST https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/filters/projects \
-H "Content-Type: application/json" \
-d '{"client_ids":["integer"],"currency":"string","ids":["integer"],"is_active":"boolean","is_billable":"boolean","is_private":"boolean","name":"string","page_size":"integer","start":"integer"}' \
-u <email>:<password>

Parameters​

Path​

nametyperequireddescription
workspace_idintegertrueWorkspace ID

Body​

nametypedescription
client_idsArray of integerClient IDs, optional.
currencystringCurrency, optional, example "EUR".
idsArray of integerProject IDs, optional.
is_activebooleanWhether the wanted projects are archived, optional, default false.
is_billablebooleanWhether the wanted projects are billable, optional, premium feature, default false.
is_privatebooleanWhether the wanted projects are private, optional, default false.
namestringProject name, optional.
page_sizeintegerPageSize is the number of records returned per page. If unset, the default value of 201 will be used.
startintegerStart is used for pagination, optional, default 0. The api will return the next projects page with id >= Start.

Response​

200​

Returns filtered projects

Array of:

nametypedescription
activeboolean-
billableboolean-
client_idinteger-
colorstring-
currencystring-
idinteger-
namestring-

400​

Maximum count of posted IDs is {value}

403​

Workspace not found/accessible

500​

Internal Server Error

POST List projects statuses​

https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/filters/projects/status

Returns filtered projects statuses from a workspace.

curl -X POST https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/filters/projects/status \
-H "Content-Type: application/json" \
-d '{"active":"boolean","ids":["integer"]}' \
-u <email>:<password>

Parameters​

Path​

nametyperequireddescription
workspace_idintegertrueWorkspace ID

Body​

nametypedescription
activebooleanWhether the wanted projects statuses are archived, optional, default false.
idsArray of integerProject IDs.

Response​

200​

Returns projects statuses

Array of:

nametypedescription
billable_amountinteger-
billable_secondsinteger-
currencystring-
estimated_secondsinteger-
idinteger-
tracked_secondsinteger-

403​

Workspace not found/accessible

500​

Internal Server Error

POST List tasks statuses​

https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/filters/tasks/status

Filter tasks statuses from a workspace

curl -X POST https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/filters/tasks/status \
-H "Content-Type: application/json" \
-d '{"ids":["integer"]}' \
-u <email>:<password>

Parameters​

Path​

nametyperequireddescription
workspace_idintegertrueWorkspace ID

Body​

nametypedescription
idsArray of integerTime entries IDs.

Response​

200​

Returns filtered tasks

Array of:

nametypedescription
billable_amountinteger-
billable_secondsinteger-
currencystring-
estimated_secondsinteger-
idinteger-
tracked_secondsinteger-

400​

At least one parameter must be set

402​

Tasks are a premium feature

403​

Workspace not found/accessible

500​

Internal Server Error

POST List tasks statuses​

https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/filters/tasks_auth/status

Filter tasks statuses from a workspace

curl -X POST https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/filters/tasks_auth/status \
-H "Content-Type: application/json" \
-d '{"ids":["integer"]}' \
-u <email>:<password>

Parameters​

Path​

nametyperequireddescription
workspace_idintegertrueWorkspace ID

Body​

nametypedescription
idsArray of integerTime entries IDs.

Response​

200​

Returns filtered tasks

Array of:

nametypedescription
billable_amountinteger-
billable_secondsinteger-
currencystring-
estimated_secondsinteger-
idinteger-
tracked_secondsinteger-

400​

At least one parameter must be set

402​

Tasks are a premium feature

403​

Workspace not found/accessible

500​

Internal Server Error

POST List users​

https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/filters/users

Returns filtered users from a workspace.

curl -X POST https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/filters/users \
-H "Content-Type: application/json" \
-d '{"active":"boolean","admin":"boolean","ids":["integer"],"start":"integer"}' \
-u <email>:<password>

Parameters​

Path​

nametyperequireddescription
workspace_idintegertrueWorkspace ID

Body​

nametypedescription
activebooleanWhether the wanted users are active, optional, default true.
adminbooleanWhether the wanted users are admins, optional, default false.
idsArray of integerUser IDs, optional.
startinteger-

Response​

200​

Returns filtered users

Array of:

nametypedescription
deleted_atstring-
idinteger-
namestring-

400​

Maximum count of posted IDs is 100

403​

Workspace not found/accessible

500​

Internal Server Error

POST Search clients​

https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/search/clients

Returns filtered clients from a workspace (whole client object).

curl -X POST https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/search/clients \
-H "Content-Type: application/json" \
-d '{"ids":["integer"],"name":"string","start":"integer"}' \
-u <email>:<password>

Parameters​

Path​

nametyperequireddescription
workspace_idintegertrueWorkspace ID

Body​

nametypedescription
idsArray of integer-
namestring-
startinteger-

Response​

200​

Returns searched clients

Array of:

400​

Possible error messages:

* At least one parameter must be set
* Maximum count of posted IDs is 2000

403​

Workspace not found/accessible

500​

Internal Server Error

POST List projects​

https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/search/projects

Returns filtered projects from a workspace (whole project object).

curl -X POST https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/search/projects \
-H "Content-Type: application/json" \
-d '{"client_ids":["integer"],"currency":"string","ids":["integer"],"is_active":"boolean","is_billable":"boolean","is_private":"boolean","name":"string","page_size":"integer","start":"integer"}' \
-u <email>:<password>

Parameters​

Path​

nametyperequireddescription
workspace_idintegertrueWorkspace ID

Body​

nametypedescription
client_idsArray of integerClient IDs, optional.
currencystringCurrency, optional, example "EUR".
idsArray of integerProject IDs, optional.
is_activebooleanWhether the wanted projects are archived, optional, default false.
is_billablebooleanWhether the wanted projects are billable, optional, premium feature, default false.
is_privatebooleanWhether the wanted projects are private, optional, default false.
namestringProject name, optional.
page_sizeintegerPageSize is the number of records returned per page. If unset, the default value of 201 will be used.
startintegerStart is used for pagination, optional, default 0. The api will return the next projects page with id >= Start.

Response​

200​

Returns projects

Array of:

nametypedescription
activeboolean-
billableboolean-
client_idinteger-
colorstring-
currencystring-
idinteger-
namestring-

400​

Possible error messages:

* At least one parameter must be set
* Maximum count of posted IDs is {value}

403​

Workspace not found/accessible

500​

Internal Server Error

POST List users​

https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/search/users

Returns filtered users from a workspace.

curl -X POST https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/search/users \
-H "Content-Type: application/json" \
-d '{"active":"boolean","admin":"boolean","ids":["integer"],"start":"integer"}' \
-u <email>:<password>

Parameters​

Path​

nametyperequireddescription
workspace_idintegertrueWorkspace ID

Body​

nametypedescription
activebooleanWhether the wanted users are active, optional, default true.
adminbooleanWhether the wanted users are admins, optional, default false.
idsArray of integerUser IDs, optional.
startinteger-

Response​

200​

Returns users

Array of:

nametypedescription
deleted_atstring-
idinteger-
namestring-

400​

Possible error messages:

* At least one parameter must be set
* Maximum count of posted IDs is 100

403​

Workspace not found/accessible

500​

Internal Server Error

POST List tasks​

https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/{action}/tasks

Returns filtered tasks from workspace.

curl -X POST https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/{action}/tasks \
-H "Content-Type: application/json" \
-d '{"active":"boolean","ids":["integer"],"name":"string","page_size":"integer","project_active":"boolean","project_ids":["integer"],"start":"integer","user_ids":["integer"]}' \
-u <email>:<password>

Parameters​

Path​

nametyperequireddescription
workspace_idintegertrueWorkspace ID
actionstringtruesearch,filters

Body​

nametypedescription
activeboolean-
idsArray of integer-
namestring-
page_sizeinteger-
project_activeboolean-
project_idsArray of integer-
startinteger-
user_idsArray of integer-

Response​

200​

Returns tasks

Array of:

nametypedescription
activeboolean-
atstring-
estimated_secondsinteger | null-
idinteger-
namestring-
permissionsstring-
project_idinteger-
recurringboolean-
server_deleted_atstring | null-
toggl_accounts_idstring | null-
tracked_secondsinteger-
user_idinteger | null-
workspace_idinteger-

400​

Possible error messages:

* At least one parameter must be set
* Maximum count of posted IDs is 2000

403​

Workspace not found/accessible

500​

Internal Server Error

POST List tasks​

https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/{action}/tasks_auth

Returns filtered tasks from workspace.

curl -X POST https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/{action}/tasks_auth \
-H "Content-Type: application/json" \
-d '{"active":"boolean","ids":["integer"],"name":"string","page_size":"integer","project_active":"boolean","project_ids":["integer"],"start":"integer","user_ids":["integer"]}' \
-u <email>:<password>

Parameters​

Path​

nametyperequireddescription
workspace_idintegertrueWorkspace ID
actionstringtruesearch,filters

Body​

nametypedescription
activeboolean-
idsArray of integer-
namestring-
page_sizeinteger-
project_activeboolean-
project_idsArray of integer-
startinteger-
user_idsArray of integer-

Response​

200​

Returns tasks

Array of:

nametypedescription
activeboolean-
atstring-
estimated_secondsinteger | null-
idinteger-
namestring-
permissionsstring-
project_idinteger-
recurringboolean-
server_deleted_atstring | null-
toggl_accounts_idstring | null-
tracked_secondsinteger-
user_idinteger | null-
workspace_idinteger-

400​

Possible error messages:

* At least one parameter must be set
* Maximum count of posted IDs is 2000

403​

Workspace not found/accessible

500​

Internal Server Error
© 2024 Toggl. All rights reserved.