KimaiInstall

Summary

Retrieve multiple timesheets from the Kimai API via GET /api/timesheets, filtered by optional query parameters.

Inputs

• begin — Filter timesheets beginning at or after this datetime. Type: dateTime. Default: empty (no filter).
• end — Filter timesheets ending at or before this datetime. Type: dateTime. Default: empty (no filter).
• user — Filter timesheets by a single user ID. Type: string. Default: empty (no filter).
• users — Comma-separated list of user IDs. Sent as query parameter users[]. Type: string. Default: empty (no filter). Routing: query property users[] with split mapping.
• customer — Filter timesheets by a single customer ID. Type: string. Default: empty (no filter).
• customers — Comma-separated list of customer IDs. Sent as query parameter customers[]. Type: string. Default: empty (no filter). Routing: query property customers[] with split mapping.
• project — Filter timesheets by a single project ID. Type: string. Default: empty (no filter).
• projects — Comma-separated list of project IDs. Sent as query parameter projects[]. Type: string. Default: empty (no filter). Routing: query property projects[] with split mapping.
• activity — Filter timesheets by a single activity ID. Type: string. Default: empty (no filter).
• activities — Comma-separated list of activity IDs. Sent as query parameter activities[]. Type: string. Default: empty (no filter). Routing: query property activities[] with split mapping.
• page — Page number for paginated results. Type: number. Default: 1.
• size — Number of results per page. Type: number. Default: 50. Also applies to getRecent operation.
• tags — Comma-separated list of tags. Sent as query parameter tags[]. Type: string. Default: empty (no filter). Routing: query property tags[] with split mapping; undefined if empty.
• orderBy — Field to order results by. Type: options. Options: ID, Begin, End, Rate. Default: begin.
• order — Sort order. Type: options. Options: ASC, DESC. Default: DESC.
• exported — Filter by export status. Type: options. Options: All (empty string), Not Exported (0), Exported (1). Default: empty (no filter).
• active — Filter by active state. Type: options. Options: All (empty string), Stopped (0), Active (1). Default: empty (no filter).
• billable — Filter by billability. Type: options. Options: All (empty string), Non-Billable (0), Billable (1). Default: empty (no filter).
• full — Include full timesheet data. Type: boolean. Default: false. When true, sends query parameter full=1; when false, sends full=0. Routing: query property full with value mapping.
• term — Search term to match against timesheet fields. Type: string. Default: empty (no filter).
• modifiedAfter — Filter timesheets modified after this datetime. Type: dateTime. Default: empty (no filter).

Output shape

Array of timesheet objects as returned by the Kimai API.

Each item corresponds to one timesheet record from the /api/timesheets endpoint, containing fields such as id, begin, end, project, activity, user, customer, tags, exported, active, billable, and hourly/fix rates depending on API response.

Examples

Example 1: Get all timesheets for a specific user

Set user to a valid user ID; leave other filters empty or adjust as needed.

Example 2: Get recent timesheets with pagination and filtering

Set size to desired limit, page to navigate, and optionally filter by user, project, begin/end dates, or exported status.