Skip to main content
GET
List an account's credit ledger

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

userId
string<uuid>
required

The account whose ledger to read

Query Parameters

transactionType
string

Only entries of this type, for instance debit for the credits spent. The types are listed on AccountCreditTransaction.

limit
integer
default:100

Maximum number of entries to return

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

Number of entries to skip

Required range: x >= 0

Response

The account's ledger entries, newest first

success
boolean
required
data
object[]
required
meta
object

Extra information about the answer: where a page sits in a list, the cursor of the next page, or warnings about a call that succeeded with a caveat.