Q2 2025 Roadmap: Request a beta API key and access upcoming features: Embedded Notifications, Team Communications and more.

Export shifts

GET

/api/timesheets/export

shifts

Exports shift data based on the provided filters.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/api/timesheets/export?type&startDate&endDate&forward'

Response Example

200 - Example 1

{
  "message": "Data exported successfully."
}

Request

Query Params

type

string

required

Format of the export (e.g., CSV, JSON).

Example:

csv

startDate

string <date>

required

Start date for the export filter.

Example:

2023-10-27

endDate

string <date>

required

End date for the export filter.

Example:

2023-10-28

employees

array[string]

optional

List of employee IDs to filter export.

Example:

["emp_001","emp_002"]

locations

array[string]

optional

List of location IDs to filter export.

Example:

["loc_001","loc_002"]

roles

array[string]

optional

List of role IDs to filter export.

Example:

["role_001","role_002"]

forward

boolean

required

Whether to forward the exported data to another system.

Example:

false

Responses

🟢200OK

application/json

Shift data exported successfully.

Body

message

string

optional

Example:

Data exported successfully.

🟠400Bad Request

Retrieve a specific shift

Generate per-employee shift reports