Statements

List statements

GEThttps://api.firstleeward.com/v0/statements

Lists statements requested for the project, most recently created first, including those First Leeward produces on a schedule.

Authorizations

Authorizationstring · headerrequired

API key as Bearer token, e.g. Bearer YOUR_API_KEY

Headers

Leeward-Versionenum<string>required

API version (YYYY-MM-DD). Available option: 2026-09-18

Query Parameters

limitintegerdefault: 20

Maximum number of items to return (1-100, default: 20)

cursorstring

Opaque cursor for pagination. Pass nextCursor from previous response to get next page.

typestring[]

Filter by statement type. Comma-separated for several.

Available options:CARD_TRANSACTION_FEESCARD_NON_TRANSACTION_FEES
statusstring[]

Filter by status. Comma-separated for several.

Available options:PENDINGGENERATEDFAILED
originstring[]

Filter by who requested the statement. Comma-separated for several.

Available options:CLIENTFIRST_LEEWARD
periodFromstring<date>

Only statements whose period starts on or after this day

periodTostring<date>

Only statements whose period ends on or before this day

Response

200Response for status 200
itemsobject[]required
Show child attributes
idstring<uuid>required

Unique statement identifier

typestringrequired

What the statement itemises

Available options:CARD_TRANSACTION_FEESCARD_NON_TRANSACTION_FEES
originstringrequired

Who requested the statement

Available options:CLIENTFIRST_LEEWARD
statusstringrequired

Current statement status

Available options:PENDINGGENERATEDFAILED
periodobjectrequired
Show child attributes
fromstring<date>required

First calendar day covered, inclusive, UTC

tostring<date>required

Last calendar day covered, inclusive, UTC

fieldsstring[] | nullrequired

Columns in the file, in order. null means every column of the type.

formatstringrequired

File format

Available options:CSV
versionstringrequired

API version the statement was requested under. Fixes the column definitions the file follows.

rowCountinteger | nullrequired

Number of data rows in the file, once generated

byteSizeinteger | nullrequired

Size of the file in bytes, once generated

dataAsOfstring | nullrequired

ISO 8601 timestamp of how fresh the source data was when the file was produced, when known

generatedAtstring | nullrequired

ISO 8601 timestamp of when the file became available

createdAtstringrequired

ISO 8601 timestamp of creation

updatedAtstringrequired

ISO 8601 timestamp of last update

nextCursorstring | nullrequired

Cursor for next page, or null if no more items