https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/search/time_entries.pdf
Downloads detailed report in pdf format.
- cURL
- Go
- Ruby
- JavaScript
- Python
- Rust
extern crate tokio;extern crate serde_json;use reqwest::{Client};use reqwest::header::{CONTENT_TYPE};#[tokio::main]async fn main() -> Result<(), reqwest::Error> { let client = Client::new().basic_auth("<email>", "<password>"); let json = client.request(Method::POST, "https://api.track.toggl.com/reports/api/v3/workspace/{workspace_id}/search/time_entries.pdf".to_string()).json(&serde_json::json!(\{"billable":"boolean","cents_separator":"string","client_ids":[\{\}],"date_format":"string","description":"string","display_mode":"string","duration_format":"string","end_date":"string","enrich_response":"boolean","first_id":"integer","first_row_number":"integer","first_timestamp":"integer","group_ids":[\{\}],"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","project_ids":[\{\}],"rounding":"integer","rounding_minutes":"integer","startTime":"string","start_date":"string","tag_ids":[\{\}],"task_ids":[\{\}],"time_entry_ids":[\{\}],"user_ids":[\{\}]\})) .header(CONTENT_TYPE, "application/json") .send() .await? .json() .await?; println!("{:#?}", json); Ok(())}
Parameters
Path
| name | type | required | description |
|---|---|---|---|
| workspace_id | integer | true | Workspace ID |
Body
| Name | Type | Description |
|---|---|---|
| billable | boolean | Whether the time entry is set as billable, optional, premium feature. |
| cents_separator | string | - |
| client_ids | Array of integer | Client IDs, optional, filtering attribute. To filter records with no clients, use [null]. |
| date_format | string | - |
| description | string | Description, optional, filtering attribute. |
| display_mode | string | - |
| duration_format | string | Duration format, optional, default “classic”. Can be “classic”, “decimal” or “improved”. |
| end_date | string | End date, example time.DateOnly. Should be greater than Start date. |
| enrich_response | boolean | EnrichResponse, optional, default false. It will force the detailed report to return as much information as possible, as it does for the export. |
| first_id | integer | - |
| first_row_number | integer | - |
| first_timestamp | integer | - |
| group_ids | Array of integer | Group IDs, optional, filtering attribute. |
| grouped | boolean | Whether time entries should be grouped, optional, default false. |
| hide_amounts | boolean | Whether amounts should be hidden, optional, default false. |
| hour_format | string | - |
| max_duration_seconds | integer | Max duration seconds, optional, filtering attribute. Time Audit only, should be greater than MinDurationSeconds. |
| min_duration_seconds | integer | Min duration seconds, optional, filtering attribute. Time Audit only, should be less than MaxDurationSeconds. |
| order_by | string | Order by field, optional, default “date”. Can be “date”, “user”, “duration”, “description” or “last_update”. |
| order_dir | string | Order direction, optional. Can be ASC or DESC. |
| page_size | integer | PageSize defines the number of items per page, optional, default 50. |
| project_ids | Array of integer | Project IDs, optional, filtering attribute. To filter records with no projects, use [null]. |
| rounding | integer | Whether time should be rounded, optional, default from user preferences. |
| rounding_minutes | integer | Rounding minutes value, optional, default from user preferences. Should be 0, 1, 5, 6, 10, 12, 15, 30, 60 or 240. |
| startTime | string | - |
| start_date | string | Start date, example time.DateOnly. Should be less than End date. |
| tag_ids | Array of integer | Tag IDs, optional, filtering attribute. To filter records with no tags, use [null]. |
| task_ids | Array of integer | Task IDs, optional, filtering attribute. To filter records with no tasks, use [null]. |
| time_entry_ids | Array of integer | TimeEntryIDs filters by time entries. This was added to support retro-compatibility with reports v2. |
| user_ids | Array of integer | User 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