List Timesheets
list_timesheetsRetrieve timesheet data organized by template, period, employee, and entries. Filter by date range or employee code to avoid timeouts.
Instructions
Get timesheet data grouped by timesheet template, sequence (period), employee and individual time entries. Warning: can return a LOT of data; always use date ranges or employee filters to avoid timeouts.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| group | No | Only return records within this group (note: the field is always called 'group' in the API even if renamed to Branch/Entity etc. in the app) | |
| status | No | Only timesheets with this header status | |
| project | No | Only timesheets with this project name attached to the entries | |
| activity | No | Only timesheets with this project activity name attached to the entries | |
| employee | No | Only timesheets for the employee with this employee code | |
| location | No | One or more location names (separated by commas) to filter by | |
| is_locked | No | Only return timesheet sequences which are locked (or unlocked) (true/false) | |
| department | No | One or more department names (separated by commas) to filter by | |
| is_approved | No | Only return approved timesheets (true/false) | |
| is_exported | No | Only return timesheet entries marked as exported (true/false) | |
| max_records | No | Optional client-side limit on the number of records returned. Use to keep responses small when exploring data; the API itself does not paginate. | |
| timesheet_name | No | Only timesheets which have this timesheet template name | |
| sequence_end_date | No | Only timesheets where the sequence (period) ends on this date (format yyyy-mm-dd) | |
| timesheet_date_to | No | Only timesheets with entries before this date (both from and to dates must be specified) (format yyyy-mm-dd) | |
| sequence_start_date | No | Only timesheets where the sequence (period) starts on this date (format yyyy-mm-dd) | |
| timesheet_date_from | No | Only timesheets with entries after this date (both from and to dates must be specified) (format yyyy-mm-dd) |