Skip to main content
GET
Download Bordereau CSV

Authorizations

Authorization
string
header
required

API key authentication. Send your raw API key as the Authorization header value with NO scheme prefix — Authorization: YOUR-API-KEY. Do NOT prefix it with Bearer or ApiKey , and do not use an X-API-Key header; those are not accepted.

Path Parameters

companyId
string<uuid>
required

Company identifier

Query Parameters

periodStart
string<date-time>

Inclusive lower bound on transactionTimestamp. Only transactions at or after this timestamp are included.

periodEnd
string<date-time>

Exclusive upper bound on transactionTimestamp. Only transactions before this timestamp are included.

actions
string

Comma-separated list of transaction actions to include. Valid values: NEW_BUSINESS, ENDORSE, CANCEL, REINSTATE, RENEW. Omit to include all actions.

Note: Unrecognized action values are not rejected — they silently match zero rows. Double-check spelling if results are unexpectedly empty.

columns
string

JSON-encoded ordered array of column specs (see BordereauColumnSpec) that COMPLETELY describes the output columns: fixed columns become selectable, omittable, and reorderable, and field columns ({"kind":"field"} entries — a dot-path into the policy's field data plus a display header, resolved per row as of the transaction's effective date) interleave anywhere. Omit for the default column set (the fixed 12).

filters
string

JSON-encoded array of policy filters (see FieldModelV1ListFilter). Restricts the export to transactions of the policies whose CURRENT segment matches every filter — the filter selects the policies, then all of each matching policy's transactions in the period are included. Omit to include every policy. Same field-filter model as the Policy List filters parameter (field types text, number, boolean, date, currency, optionSet, address, join, and the list-cardinality types).

sortBy
enum<string>

Field to sort results by. Default transactionTimestamp.

Available options:
policyNumber,
primaryInsuredName,
effectiveDate,
transactionTimestamp,
createdAt
sortDirection
enum<string>
default:desc

Sort direction (default desc).

Available options:
asc,
desc
limit
integer
default:50000

Maximum number of rows to include. Default and maximum 50,000.

Required range: 1 <= x <= 50000
offset
integer
default:0

Number of rows to skip before starting the export. Default 0.

Required range: x >= 0

Response

CSV file download

The response is of type string.