Skip to main content
An administrator starts an export with POST /exports. The response is 202 Accepted with a Location URL. Poll that URL with GET /exports/{id}/file until it returns 200 and the file. Send the API key on every request. It is not part of the Location URL. Only an administrator can start or download an export. The REST API requires Plus. A period without absences produces a file. The job also appears under Recent exports on Settings > Export, with via API next to the requester. Any admin can select Download there when the file is Ready.

Formats

Send format as one of these values. They match the formats on Settings > Export for a Range.

Start an export

start is the first day. end is the last day, inclusive. Only the UTC date is used. The range may span at most 1826 days (5 years). Wider or inverted ranges return 400. Optional department_id limits the file to one department. Omit it for all departments. For PAYROLL_CSV, optional csv_separator is comma or semicolon. Send the key as X-API-KEY or as Authorization: Bearer <key>. In a Power Automate HTTP action, set Authentication to Raw with Bearer <key>, so the same header is sent on the poll requests. The JSON body of a 202 is { "id": "...", "status": "processing" }. Poll the Location URL. Wait the number of seconds in Retry-After (15) between requests. If POST /exports returns 429, see API limits.

Download the file

GET /exports/{id}/file uses the same credentials.