Skip to main content
GET
Tenant-wide ledger

Authorizations

Authorization
string
header
required

Locus Pro dashboard session (Cognito).

Query Parameters

category
enum<string>
Available options:
TOPUP,
BURN,
REFUND,
CLAWBACK,
FEE,
ADJUSTMENT,
ALLOCATION,
PROMO
externalUserId
string

Case-sensitive immutable ID in the tenant namespace. Prefer an identity-provider subject, not an email address.

Required string length: 1 - 200
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:@/-]{0,199}$
initiator
string

Spender reference :, matching the analytics initiator identity. Cannot be combined with externalUserId or account=platform; unattributed is not filterable.

provider
string

Matches the provider recorded on the ledger entry. Legacy entries without provider metadata are excluded from this filtered ledger view.

endpoint
string

metadata.endpoint equality. Requires provider.

createdAfter
string<date-time>

Inclusive lower bound. Strict ISO-8601.

createdBefore
string<date-time>

Exclusive upper bound. Strict ISO-8601.

attribution.{key}
string

Equality filter on metadata.attribution., one query parameter per key: attribution.entityId=acct_889. Dot form only — bracket form is not parsed.

sourceKey
string

Narrow to one ledger event kind, e.g. wapi_burn or stripe_topup.

account
enum<string>

Restrict to the tenant's pooled platform account. Mutually exclusive with externalUserId and with an end-user initiator.

Available options:
platform
cursor
string
limit
integer
default:50
Required range: 1 <= x <= 200

Response

200 - application/json

Ledger page

success
boolean
required
entries
object[]
required
nextCursor
string | null
required
appliedFilters
enum<string>[]
required

Names of the narrowing query filters this server applied. An empty array means the request did not include a narrowing filter.

Available options:
account,
attribution,
category,
createdAfter,
createdBefore,
endpoint,
externalUserId,
initiator,
provider,
sourceKey