Skip to main content
POST
Start an export

Authorizations

X-API-KEY
string
header
required

Body

application/json
format
enum<string>
required

EXCEL is the absence workbook. PAYROLL_EXCEL and PAYROLL_CSV are the payroll files. LEAVE_BALANCE_EXCEL is the leave balances workbook.

Available options:
EXCEL,
PAYROLL_EXCEL,
PAYROLL_CSV,
LEAVE_BALANCE_EXCEL
start
string
required

Date/time in ISO 8601 format, e.g. 2026-06-01 (interpreted as UTC midnight) or 2026-06-01T09:00:00Z. Always include a time zone designator (Z for UTC) when sending a time of day. Localized formats such as 01.06.2026 or 06/01/2026 are misinterpreted and must not be used. First day of the export. Only the UTC date is used. The range may span at most 1826 days (5 years).

end
string
required

Date/time in ISO 8601 format, e.g. 2026-06-01 (interpreted as UTC midnight) or 2026-06-01T09:00:00Z. Always include a time zone designator (Z for UTC) when sending a time of day. Localized formats such as 01.06.2026 or 06/01/2026 are misinterpreted and must not be used. Last day of the export, inclusive. Only the UTC date is used.

department_id
string

Limit the export to one department. Omit for all departments.

Minimum string length: 1
csv_separator
enum<string>

Only used by PAYROLL_CSV.

Available options:
comma,
semicolon

Response

Export started. Poll the Location URL for the file.

id
string
required
status
string
required
Allowed value: "processing"