---
title: "List the affiliate ledger"
method: GET
path: "/affiliate/ledger/"
tags: ["affiliate"]
---

# List the affiliate ledger

`GET /affiliate/ledger/`

## Request

- Base URL: `https://api.getoneprofile.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.getoneprofile.ai/affiliate/ledger/`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

The itemized, signed history of every commission, clawback, payout and adjustment, newest first.

## Query parameters

- `limit` integer: The number of items to return.
- `order_by` 'id' | 'occurred_at' | 'created_at'
- `order_direction` 'asc' | 'desc'
- `cursor` string, nullable: Set the cursor to the next or previous page. You can get the cursor from the previous page's response.

## Response `200`

Successful Response

- PaginatedResponseAffiliateLedgerEntryReadSchema
  - `data` AffiliateLedgerEntryReadSchema[]: The list of ResponseItems.
    - `amount_cents` integer, required
    - `available_at` string, date-time, nullable, required: When a commission matures into the payable balance; null for immediate kinds.
    - `currency` string, required
    - `description` string, required
    - `id` string, uuid, required
    - `kind` 'commission' | 'clawback_refund' | 'clawback_dispute' | 'dispute_reversal' | 'payout' | 'adjustment' | 'forfeiture', required: The kind of an affiliate ledger entry. Amounts are signed USD cents.
    - `occurred_at` string, date-time, required
  - `next_page_cursor` string, nullable: The cursor to the next page. If there are no more pages, this is None.
  - `previous_page_cursor` string, nullable: The cursor to the previous page. If there are no previous pages, this is None.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `422`: Invalid request made to the API.
- `500`: Internal server error.
- `502`: Bad gateway error.
- `503`: Service unavailable.

---

[API](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile.md) · [All operations](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/llms.txt) · [OpenAPI document](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/revisions/dc5ac3c84444?raw)