Skip to main content

Exports

POST Export employee profitability insights​

https://api.track.toggl.com/insights/api/v1/workspace/{workspace_id}/profitability/employees.{extension}

Downloads employee profitability insights in the specified format: csv or xlsx.

curl -X POST https://api.track.toggl.com/insights/api/v1/workspace/{workspace_id}/profitability/employees.{extension} \
-H "Content-Type: application/json" \
-d '{"currency":"string","end_date":"string","group_ids":"string","resolution":"string","rounding":"integer","rounding_minutes":"integer","start_date":"string","user_ids":"string"}' \
-u <email>:<password>

Parameters​

Body​

nametypedescription
currencystring-
end_datestring-
group_idsstring-
resolutionstring-
roundinginteger-
rounding_minutesinteger-
start_datestring-
user_idsstring-

Response​

200​

A stream with the csv or xlsx for the report being exported

400​

Invalid parameters

403​

User has no access to workspace or is not admin

500​

Internal Server Error

POST Export profitability project insights​

https://api.track.toggl.com/insights/api/v1/workspace/{workspace_id}/profitability/projects.{extension}

Downloads profitability project insights in the specified format: csv or xlsx.

curl -X POST https://api.track.toggl.com/insights/api/v1/workspace/{workspace_id}/profitability/projects.{extension} \
-H "Content-Type: application/json" \
-d '{"billable":"boolean","client_ids":["integer"],"currency":"string","end_date":"string","project_ids":["integer"],"resolution":"string","rounding":"integer","rounding_minutes":"integer","start_date":"string"}' \
-u <email>:<password>

Parameters​

Path​

nametyperequireddescription
extensionstringtruecsv,xlsx

Body​

nametypedescription
billablebooleanWhether the project is set as billable, optional, premium feature.
client_idsArray of integerClient IDs, optional. A nil entry on this list means that only projects without client will be selected.
currencystringCurrency, example: "usd".
end_datestringEnd date, optional, example: time.DateOnly. Should be greater than Start date.
project_idsArray of integerProject IDS, optional.
resolutionstringResolution, optional. Can be "day", "week" or "month".
roundingintegerRounding, optional, duration rounding settings, premium feature.
rounding_minutesintegerRoundingMinutes, optional, duration rounding minutes settings, premium feature.
start_datestringStart date, optional, example: time.DateOnly. Should be less than End date.

Response​

200​

A stream with the csv or xlsx for the report being exported

400​

Possible error messages:

* Invalid parameters
* Invalid workspace ID

403​

User has no access to workspace or is not admin

500​

Internal Server Error

POST Export projects data trends​

https://api.track.toggl.com/insights/api/v1/workspace/{workspace_id}/trends/projects.{extension}

Downloads projects data trends in the specified format: csv or xlsx.

curl -X POST https://api.track.toggl.com/insights/api/v1/workspace/{workspace_id}/trends/projects.{extension} \
-H "Content-Type: application/json" \
-d '{"billable":"boolean","end_date":"string","previous_period_start":"string","project_ids":["integer"],"rounding":"integer","rounding_minutes":"integer","start_date":"string"}' \
-u <email>:<password>

Parameters​

Path​

nametyperequireddescription
workspace_idintegertrueWorkspace ID
extensionstringtruecsv,xlsx

Body​

nametypedescription
billablebooleanWhether the project is set as billable, optional, premium feature.
end_datestringEnd date, example time.DateOnly. Should be greater than Start date.
previous_period_startstringPrevious start date, example time.DateOnly.
project_idsArray of integerProject IDs, optional.
roundingintegerRounding, optional, duration rounding settings, premium feature.
rounding_minutesintegerRoundingMinutes, optional, duration rounding minutes settings, premium feature.
start_datestringStart date, example time.DateOnly. Should be less than End date.

Response​

200​

Returns data projects data trends

Array of:

nametypedescription
current_period_secondsArray of integer-
previous_period_secondsArray of integer-
project_idinteger-
startstring-
user_idsArray of integer-

400​

Possible error messages:

* At least one parameter must be set
* Invalid workspace id
* wrong format date
* start should come after end

403​

Possible error messages:

* Workspace not found/accessible"
* user has no required access to asked workspace

500​

Internal Server Error

POST Export CSV for saved report​

https://api.track.toggl.com/reports/api/v3/shared/{report_token}.csv

Downloads a previously saved report in csv.

Authentication

A public report is accessible by anyone, a private one is only accessible by the report's owner or workspace admin. If the criteria aren't met it returns 403 status code.

Parameters

The report can be executed without parameters, and in this case the saved or default parameters will be used.

curl -X POST https://api.track.toggl.com/reports/api/v3/shared/{report_token}.csv \
-H "Content-Type: application/json" \
-u <email>:<password>

Response​

200​

Returns report information in csv form

400​

Possible error messages:

* report_type does not exist in params
* The report period is not supported

401​

Possible error messages:

* Unable to extract authentication data
* Incorrect username and/or password

403​

Possible error messages:

* Invalid token
* Workspace was not found or the report's owner is no longer active on it

404​

Not found

500​

parameter \`since\` is missing

POST Export XSLX saved report​

https://api.track.toggl.com/reports/api/v3/shared/{report_token}.xlsx

Downloads a previously saved report in xlsx.

Authentication

A public report is accessible by anyone, a private one is only accessible by the report's owner or workspace admin. If the criteria aren't met it returns 403 status code.

Parameters

The report can be executed without parameters, and in this case the saved or default parameters will be used.

curl -X POST https://api.track.toggl.com/reports/api/v3/shared/{report_token}.xlsx \
-H "Content-Type: application/json" \
-u <email>:<password>

Response​

200​

Returns report information in xlsx form

400​

Possible error messages:

* report_type does not exist in params
* The report period is not supported

401​

Possible error messages:

* Unable to extract authentication data
* Incorrect username and/or password

403​

Possible error messages:

* Invalid token
* Workspace was not found or the report's owner is no longer active on it

404​

Not found

500​

parameter \`since\` is missing

POST Export saved report in pdf format​

https://api.track.toggl.com/reports/api/v3/shared/{report_token}/pdf

Authentication

A public report is accessible by anyone, a private one is only accessible by the report's owner or workspace admin. If the criteria aren't met it returns 403 status code.

Parameters

The report can be executed without parameters, and in this case the saved or default parameters will be used.

curl -X POST https://api.track.toggl.com/reports/api/v3/shared/{report_token}/pdf \
-H "Content-Type: application/json" \
-u <email>:<password>

Response​

200​

Returns report information in pdf form

400​

Possible error messages:

* report_type does not exist in params
* The report period is not supported

401​

Possible error messages:

* Unable to extract authentication data
* Incorrect username and/or password

403​

Possible error messages:

* Invalid token
* Workspace was not found or the report's owner is no longer active on it

404​

Not found

500​

parameter \`since\` is missing

POST Export detailed report​

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

Downloads detailed report in pdf format.

curl -X POST https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/search/time_entries.pdf \
-H "Content-Type: application/json" \
-d '{"billable":"boolean","cents_separator":"string","client_ids":["integer"],"date_format":"string","description":"string","display_mode":"string","duration_format":"string","end_date":"string","first_id":"integer","first_row_number":"integer","first_timestamp":"integer","group_ids":["integer"],"grouped":"boolean","hide_amounts":"boolean","hour_format":"string","max_duration_seconds":"integer","min_duration_seconds":"integer","order_by":"string","order_dir":"string","page_size":"integer","postedFields":["string"],"project_ids":["integer"],"rounding":"integer","rounding_minutes":"integer","startTime":"string","start_date":"string","tag_ids":["integer"],"task_ids":["integer"],"time_entry_ids":["integer"],"user_ids":["integer"]}' \
-u <email>:<password>

Parameters​

Path​

nametyperequireddescription
workspace_idintegertrueWorkspace ID

Body​

nametypedescription
billablebooleanWhether the time entry is set as billable, optional, premium feature.
cents_separatorstring-
client_idsArray of integerClient IDs, optional, filtering attribute. To filter records with no clients, use [null].
date_formatstring-
descriptionstringDescription, optional, filtering attribute.
display_modestring-
duration_formatstringDuration format, optional, default "classic". Can be "classic", "decimal" or "improved".
end_datestringEnd date, example time.DateOnly. Should be greater than Start date.
first_idinteger-
first_row_numberinteger-
first_timestampinteger-
group_idsArray of integerGroup IDs, optional, filtering attribute.
groupedbooleanWhether time entries should be grouped, optional, default false.
hide_amountsbooleanWhether amounts should be hidden, optional, default false.
hour_formatstring-
max_duration_secondsintegerMax duration seconds, optional, filtering attribute. Time Audit only, should be greater than MinDurationSeconds.
min_duration_secondsintegerMin duration seconds, optional, filtering attribute. Time Audit only, should be less than MaxDurationSeconds.
order_bystringOrder by field, optional, default "date". Can be "date", "user", "duration", "description" or "last_update".
order_dirstringOrder direction, optional. Can be ASC or DESC.
page_sizeintegerPageSize defines the number of items per page, optional, default 50.
postedFieldsArray of string-
project_idsArray of integerProject IDs, optional, filtering attribute. To filter records with no projects, use [null].
roundingintegerWhether time should be rounded, optional, default from workspace settings.
rounding_minutesintegerRounding minutes value, optional, default from workspace settings. Should be 0, 1, 5, 6, 10, 12, 15, 30, 60 or 240.
startTimestring-
start_datestringStart date, example time.DateOnly. Should be less than End date.
tag_idsArray of integerTag IDs, optional, filtering attribute. To filter records with no tags, use [null].
task_idsArray of integerTask IDs, optional, filtering attribute. To filter records with no tasks, use [null].
time_entry_idsArray of integerTimeEntryIDs filters by time entries. This was added to support retro-compatibility with reports v2.
user_idsArray of integerUser IDs, optional, filtering attribute.

Response​

200​

Returns the detailed report in pdf format

400​

Possible error messages:

* At least one parameter must be set
* Invalid workspace id
* Invalid '{parameter}' value, allowed values are: '{valid_values}'

402​

Workspace needs to have this feature enabled

403​

Workspace not found/accessible

500​

Internal Server Error

POST Export detailed report​

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

Downloads detailed report in the specified format: csv or xlsx.

curl -X POST https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/search/time_entries.{extension} \
-H "Content-Type: application/json" \
-d '{"billable":"boolean","client_ids":["integer"],"description":"string","duration_format":"string","end_date":"string","first_id":"integer","first_row_number":"integer","first_timestamp":"integer","group_ids":["integer"],"grouped":"boolean","hide_amounts":"boolean","max_duration_seconds":"integer","min_duration_seconds":"integer","order_by":"string","order_dir":"string","page_size":"integer","postedFields":["string"],"project_ids":["integer"],"rounding":"integer","rounding_minutes":"integer","startTime":"string","start_date":"string","tag_ids":["integer"],"task_ids":["integer"],"time_entry_ids":["integer"],"user_ids":["integer"]}' \
-u <email>:<password>

Parameters​

Path​

nametyperequireddescription
workspace_idintegertrueWorkspace ID
extensionstringtruecsv,xlsx

Body​

nametypedescription
billablebooleanWhether the time entry is set as billable, optional, premium feature.
client_idsArray of integerClient IDs, optional, filtering attribute. To filter records with no clients, use [null].
descriptionstringDescription, optional, filtering attribute.
duration_formatstringDuration format, optional, default "classic". Can be "classic", "decimal" or "improved".
end_datestringEnd date, example time.DateOnly. Should be greater than Start date.
first_idinteger-
first_row_numberinteger-
first_timestampinteger-
group_idsArray of integerGroup IDs, optional, filtering attribute.
groupedbooleanWhether time entries should be grouped, optional, default false.
hide_amountsbooleanWhether amounts should be hidden, optional, default false.
max_duration_secondsintegerMax duration seconds, optional, filtering attribute. Time Audit only, should be greater than MinDurationSeconds.
min_duration_secondsintegerMin duration seconds, optional, filtering attribute. Time Audit only, should be less than MaxDurationSeconds.
order_bystringOrder by field, optional, default "date". Can be "date", "user", "duration", "description" or "last_update".
order_dirstringOrder direction, optional. Can be ASC or DESC.
page_sizeintegerPageSize defines the number of items per page, optional, default 50.
postedFieldsArray of string-
project_idsArray of integerProject IDs, optional, filtering attribute. To filter records with no projects, use [null].
roundingintegerWhether time should be rounded, optional, default from workspace settings.
rounding_minutesintegerRounding minutes value, optional, default from workspace settings. Should be 0, 1, 5, 6, 10, 12, 15, 30, 60 or 240.
startTimestring-
start_datestringStart date, example time.DateOnly. Should be less than End date.
tag_idsArray of integerTag IDs, optional, filtering attribute. To filter records with no tags, use [null].
task_idsArray of integerTask IDs, optional, filtering attribute. To filter records with no tasks, use [null].
time_entry_idsArray of integerTimeEntryIDs filters by time entries. This was added to support retro-compatibility with reports v2.
user_idsArray of integerUser IDs, optional, filtering attribute.

Response​

200​

Returns the detailed report in the specified format: csv or xlsx

400​

Possible error messages:

* At least one parameter must be set
* Invalid workspace id
* Invalid '{parameter}' value, allowed values are: '{valid_values}'

402​

Workspace needs to have this feature enabled

403​

Workspace not found/accessible

500​

Internal Server Error

POST Export summary report​

https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/summary/time_entries.pdf

Downloads summary report in pdf format.

curl -X POST https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/summary/time_entries.pdf \
-H "Content-Type: application/json" \
-d '{"audit":{"group_filter":{"currency":"string","max_amount_cents":"integer","max_duration_seconds":"integer","min_amount_cents":"integer","min_duration_seconds":"integer"},"show_empty_groups":"boolean","show_tracked_groups":"boolean"},"billable":"boolean","cents_separator":"string","client_ids":["integer"],"collapse":"boolean","date_format":"string","description":"string","distinguish_rates":"boolean","duration_format":"string","end_date":"string","group_ids":["integer"],"grouping":"string","hide_amounts":"boolean","hide_rates":"boolean","include_time_entry_ids":"boolean","max_duration_seconds":"integer","min_duration_seconds":"integer","order_by":"string","order_dir":"string","postedFields":["string"],"project_ids":["integer"],"resolution":"string","rounding":"integer","rounding_minutes":"integer","startTime":"string","start_date":"string","sub_grouping":"string","tag_ids":["integer"],"task_ids":["integer"],"time_entry_ids":["integer"],"user_ids":["integer"]}' \
-u <email>:<password>

Parameters​

Path​

nametyperequireddescription
workspace_idintegertrueWorkspace ID

Body​

nametypedescription
audit
nametypedescription
group_filter
nametypedescription
currencystringAudit currency, optional, example "USD", premium feature.
max_amount_centsintegerAudit max amount in cents, optional, premium feature.
max_duration_secondsintegerAudit max duration in seconds, optional, premium feature.
min_amount_centsintegerAudit min amount in cents, optional, premium feature.
min_duration_secondsintegerAudit min duration in seconds, optional, premium feature.
-
show_empty_groupsbooleanWhether empty groups should be displayed, default false, premium feature.
show_tracked_groupsbooleanWhether tacked groups should be displayed, default true, premium feature.
-
billablebooleanWhether the time entry is set as billable, optional, premium feature.
cents_separatorstring-
client_idsArray of integerClient IDs, optional, filtering attribute. To filter records with no clients, use [null].
collapsebooleanWhether collapse others, optional, default false.
date_formatstringDate format, optional, default "MM/DD/YYYY". Can be "MM/DD/YYYY", "DD-MM-YYYY", "MM-DD-YYYY", "YYYY-MM-DD", "DD/MM/YYYY" or "DD.MM.YYYY".
descriptionstringDescription, optional, filtering attribute.
distinguish_ratesbooleanDistinguishRates will create new subgroups for each rate, optional, default false.
duration_formatstringDuration format, optional, default "classic". Can be "classic", "decimal" or "improved".
end_datestringEnd date, example time.DateOnly. Should be greater than Start date.
group_idsArray of integerGroup IDs, optional, filtering attribute.
groupingstringGrouping option, optional.
hide_amountsbooleanWhether amounts should be hidden, optional, default false.
hide_ratesbooleanWhether rates should be hidden, optional, default false.
include_time_entry_idsbooleanWhether time entry IDs should be included in the results, optional, default false. Not applicable for export.
max_duration_secondsintegerMax duration seconds, optional, filtering attribute. Time Audit only, should be greater than MinDurationSeconds.
min_duration_secondsintegerMin duration seconds, optional, filtering attribute. Time Audit only, should be less than MaxDurationSeconds.
order_bystringOrder by option, optional, default title. Can be title or duration.
order_dirstringOrder direction, optional. Can be ASC or DESC.
postedFieldsArray of string-
project_idsArray of integerProject IDs, optional, filtering attribute. To filter records with no projects, use [null].
resolutionstringGraph resolution, optional. Allow clients to explicitly request a resolution.
roundingintegerWhether time should be rounded, optional, default from workspace settings.
rounding_minutesintegerRounding minutes value, optional, default from workspace settings. Should be 0, 1, 5, 6, 10, 12, 15, 30, 60 or 240.
startTimestring-
start_datestringStart date, example time.DateOnly. Should be less than End date.
sub_groupingstringSubGrouping option, optional.
tag_idsArray of integerTag IDs, optional, filtering attribute. To filter records with no tags, use [null].
task_idsArray of integerTask IDs, optional, filtering attribute. To filter records with no tasks, use [null].
time_entry_idsArray of integerTimeEntryIDs filters by time entries. This was added to support retro-compatibility with reports v2.
user_idsArray of integerUser IDs, optional, filtering attribute.

Response​

200​

Returns the summary report in pdf format

400​

Possible error messages:

* At least one parameter must be set
* Invalid workspace id
* Invalid '{parameter}' value, allowed values are: '{valid_values}'

402​

Workspace needs to have this feature enabled

403​

Workspace not found/accessible

500​

Internal Server Error

POST Export summary report​

https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/summary/time_entries.{extension}

Downloads summary report in the specified in the specified format: csv or xlsx.

curl -X POST https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/summary/time_entries.{extension} \
-H "Content-Type: application/json" \
-d '{"audit":{"group_filter":{"currency":"string","max_amount_cents":"integer","max_duration_seconds":"integer","min_amount_cents":"integer","min_duration_seconds":"integer"},"show_empty_groups":"boolean","show_tracked_groups":"boolean"},"billable":"boolean","client_ids":["integer"],"collapse":"boolean","description":"string","distinguish_rates":"boolean","duration_format":"string","end_date":"string","group_ids":["integer"],"grouping":"string","hide_amounts":"boolean","hide_rates":"boolean","include_time_entry_ids":"boolean","max_duration_seconds":"integer","min_duration_seconds":"integer","order_by":"string","order_dir":"string","postedFields":["string"],"project_ids":["integer"],"rounding":"integer","rounding_minutes":"integer","startTime":"string","start_date":"string","sub_grouping":"string","tag_ids":["integer"],"task_ids":["integer"],"time_entry_ids":["integer"],"user_ids":["integer"]}' \
-u <email>:<password>

Parameters​

Path​

nametyperequireddescription
workspace_idintegertrueWorkspace ID
extensionstringtruecsv,xlsx

Body​

nametypedescription
audit
nametypedescription
group_filter
nametypedescription
currencystringAudit currency, optional, example "USD", premium feature.
max_amount_centsintegerAudit max amount in cents, optional, premium feature.
max_duration_secondsintegerAudit max duration in seconds, optional, premium feature.
min_amount_centsintegerAudit min amount in cents, optional, premium feature.
min_duration_secondsintegerAudit min duration in seconds, optional, premium feature.
-
show_empty_groupsbooleanWhether empty groups should be displayed, default false, premium feature.
show_tracked_groupsbooleanWhether tacked groups should be displayed, default true, premium feature.
-
billablebooleanWhether the time entry is set as billable, optional, premium feature.
client_idsArray of integerClient IDs, optional, filtering attribute. To filter records with no clients, use [null].
collapsebooleanWhether collapse others, optional, default false.
descriptionstringDescription, optional, filtering attribute.
distinguish_ratesbooleanDistinguishRates will create new subgroups for each rate, optional, default false.
duration_formatstringDuration format, optional, default "classic". Can be "classic", "decimal" or "improved".
end_datestringEnd date, example time.DateOnly. Should be greater than Start date.
group_idsArray of integerGroup IDs, optional, filtering attribute.
groupingstringGrouping option, optional.
hide_amountsbooleanWhether amounts should be hidden, optional, default false.
hide_ratesbooleanWhether rates should be hidden, optional, default false.
include_time_entry_idsbooleanWhether time entry IDs should be included in the results, optional, default false. Not applicable for export.
max_duration_secondsintegerMax duration seconds, optional, filtering attribute. Time Audit only, should be greater than MinDurationSeconds.
min_duration_secondsintegerMin duration seconds, optional, filtering attribute. Time Audit only, should be less than MaxDurationSeconds.
order_bystringOrder by option, optional, default title. Can be title or duration.
order_dirstringOrder direction, optional. Can be ASC or DESC.
postedFieldsArray of string-
project_idsArray of integerProject IDs, optional, filtering attribute. To filter records with no projects, use [null].
roundingintegerWhether time should be rounded, optional, default from workspace settings.
rounding_minutesintegerRounding minutes value, optional, default from workspace settings. Should be 0, 1, 5, 6, 10, 12, 15, 30, 60 or 240.
startTimestring-
start_datestringStart date, example time.DateOnly. Should be less than End date.
sub_groupingstringSubGrouping option, optional.
tag_idsArray of integerTag IDs, optional, filtering attribute. To filter records with no tags, use [null].
task_idsArray of integerTask IDs, optional, filtering attribute. To filter records with no tasks, use [null].
time_entry_idsArray of integerTimeEntryIDs filters by time entries. This was added to support retro-compatibility with reports v2.
user_idsArray of integerUser IDs, optional, filtering attribute.

Response​

200​

Returns the summary report on the specified format: csv or xlsx

400​

Possible error messages:

* At least one parameter must be set
* Invalid workspace id
* Invalid '{parameter}' value, allowed values are: '{valid_values}'

402​

Workspace needs to have this feature enabled

403​

Workspace not found/accessible

500​

Internal Server Error

POST Export weekly report​

https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/weekly/time_entries.csv

Downloads weekly report in csv format.

curl -X POST https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/weekly/time_entries.csv \
-H "Content-Type: application/json" \
-d '{"billable":"boolean","calculate":"string","client_ids":["integer"],"description":"string","end_date":"string","group_by_task":"boolean","group_ids":["integer"],"grouping":"string","max_duration_seconds":"integer","min_duration_seconds":"integer","postedFields":["string"],"project_ids":["integer"],"rounding":"integer","rounding_minutes":"integer","startTime":"string","start_date":"string","tag_ids":["integer"],"task_ids":["integer"],"time_entry_ids":["integer"],"user_ids":["integer"]}' \
-u <email>:<password>

Parameters​

Path​

nametyperequireddescription
workspace_idintegertrueWorkspace ID

Body​

nametypedescription
billablebooleanWhether the time entry is set as billable, optional, premium feature.
calculatestringCalculate option, optional. Can be by time or amounts.
client_idsArray of integerClient IDs, optional, filtering attribute. To filter records with no clients, use [null].
descriptionstringDescription, optional, filtering attribute.
end_datestringEnd date, example time.DateOnly. Should be greater than Start date.
group_by_taskbooleanGroupByTask tells the weekly report to return the data grouped by all the usual groups plus planned task.
group_idsArray of integerGroup IDs, optional, filtering attribute.
groupingstringGrouping option, optional.
max_duration_secondsintegerMax duration seconds, optional, filtering attribute. Time Audit only, should be greater than MinDurationSeconds.
min_duration_secondsintegerMin duration seconds, optional, filtering attribute. Time Audit only, should be less than MaxDurationSeconds.
postedFieldsArray of string-
project_idsArray of integerProject IDs, optional, filtering attribute. To filter records with no projects, use [null].
roundingintegerWhether time should be rounded, optional, default from workspace settings.
rounding_minutesintegerRounding minutes value, optional, default from workspace settings. Should be 0, 1, 5, 6, 10, 12, 15, 30, 60 or 240.
startTimestring-
start_datestringStart date, example time.DateOnly. Should be less than End date.
tag_idsArray of integerTag IDs, optional, filtering attribute. To filter records with no tags, use [null].
task_idsArray of integerTask IDs, optional, filtering attribute. To filter records with no tasks, use [null].
time_entry_idsArray of integerTimeEntryIDs filters by time entries. This was added to support retro-compatibility with reports v2.
user_idsArray of integerUser IDs, optional, filtering attribute.

Response​

200​

Returns the weekly report in csv format

400​

Possible error messages:

* At least one parameter must be set
* Invalid workspace id
* The '{parameter}' parameter is not supported
* Invalid '{parameter}' value, allowed values are: '{valid_values}'

402​

Workspace needs to have this feature enabled

403​

Workspace not found/accessible

500​

Internal Server Error

POST Export weekly report​

https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/weekly/time_entries.pdf

Downloads weekly report in pdf format.

curl -X POST https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/weekly/time_entries.pdf \
-H "Content-Type: application/json" \
-d '{"billable":"boolean","calculate":"string","cents_separator":"string","client_ids":["integer"],"date_format":"string","description":"string","duration_format":"string","end_date":"string","group_by_task":"boolean","group_ids":["integer"],"grouping":"string","max_duration_seconds":"integer","min_duration_seconds":"integer","postedFields":["string"],"project_ids":["integer"],"rounding":"integer","rounding_minutes":"integer","startTime":"string","start_date":"string","tag_ids":["integer"],"task_ids":["integer"],"time_entry_ids":["integer"],"user_ids":["integer"]}' \
-u <email>:<password>

Parameters​

Path​

nametyperequireddescription
workspace_idintegertrueWorkspace ID

Body​

nametypedescription
billablebooleanWhether the time entry is set as billable, optional, premium feature.
calculatestringCalculate option, optional. Can be by time or amounts.
cents_separatorstring-
client_idsArray of integerClient IDs, optional, filtering attribute. To filter records with no clients, use [null].
date_formatstringDate format, optional, default "MM/DD/YYYY". Can be "MM/DD/YYYY", "DD-MM-YYYY", "MM-DD-YYYY", "YYYY-MM-DD", "DD/MM/YYYY" or "DD.MM.YYYY".
descriptionstringDescription, optional, filtering attribute.
duration_formatstringDuration format, optional, default "classic". Can be "classic", "decimal" or "improved".
end_datestringEnd date, example time.DateOnly. Should be greater than Start date.
group_by_taskbooleanGroupByTask tells the weekly report to return the data grouped by all the usual groups plus planned task.
group_idsArray of integerGroup IDs, optional, filtering attribute.
groupingstringGrouping option, optional.
max_duration_secondsintegerMax duration seconds, optional, filtering attribute. Time Audit only, should be greater than MinDurationSeconds.
min_duration_secondsintegerMin duration seconds, optional, filtering attribute. Time Audit only, should be less than MaxDurationSeconds.
postedFieldsArray of string-
project_idsArray of integerProject IDs, optional, filtering attribute. To filter records with no projects, use [null].
roundingintegerWhether time should be rounded, optional, default from workspace settings.
rounding_minutesintegerRounding minutes value, optional, default from workspace settings. Should be 0, 1, 5, 6, 10, 12, 15, 30, 60 or 240.
startTimestring-
start_datestringStart date, example time.DateOnly. Should be less than End date.
tag_idsArray of integerTag IDs, optional, filtering attribute. To filter records with no tags, use [null].
task_idsArray of integerTask IDs, optional, filtering attribute. To filter records with no tasks, use [null].
time_entry_idsArray of integerTimeEntryIDs filters by time entries. This was added to support retro-compatibility with reports v2.
user_idsArray of integerUser IDs, optional, filtering attribute.

Response​

200​

Returns the weekly report in pdf format

400​

Possible error messages:

* At least one parameter must be set
* Invalid workspace id
* The '{parameter}' parameter is not supported
* Invalid '{parameter}' value, allowed values are: '{valid_values}'

402​

Workspace needs to have this feature enabled

403​

Workspace not found/accessible

500​

Internal Server Error
© 2024 Toggl. All rights reserved.