Skip to main content
GET
Export statements roster as CSV

Description

Export statements roster (CSV) Streaming CSV sibling of GET /statements — same admin guard and the same unpaginated readRoster query, streamed via fast-csv instead of a JSON envelope. Registered at /export (not nested under /users/*) so it can never be swallowed by a param route. Object/array fields (flags, breakdownSnapshot, deductionsSnapshot, statusHistory) are JSON-stringified per CSV cell. Authorization:
  • Required role: admin or higher

Code Examples

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Query Parameters

periodStart
string<date>

Provide together with periodEnd, or omit both for all periods.

periodEnd
string<date>

Response

CSV stream of the statements roster.

The response is of type file.