Skip to main content
GET
Get statements roster

Description

Get statements roster Return the roster of statements for the active tenant in a [periodStart, periodEnd) window. Union of:
  • persisted Statement rows in the window
  • ledger-derived pseudo-statements for users with activity but no row yet (readFrom='ledger_fallback').
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>
required
periodEnd
string<date>
required
grain
enum<string>
Available options:
monthly,
quarterly,
semester,
tertile,
custom
status
string

Comma-separated list of statuses to include.

page
integer
default:1
pageSize
integer
default:25

Response

Roster fetched.

Every statements response wraps the payload in { status, message, data }. data carries the per-endpoint payload PLUS the per-tenant feature flag.

status
enum<string>
Available options:
success,
error
message
string
data
object