---
title: "List credit ledger entries"
method: GET
path: "/credits/ledger/"
tags: ["credits"]
---

# List credit ledger entries

`GET /credits/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/credits/ledger/`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

The raw immutable ledger (detailed retention window only), newest first by default.

## Query parameters

- `entry_kind` 'grant' | 'expiry' | 'pack_purchase' | 'charge' | 'refund' | 'referral' | 'adjustment': The kind of a credit ledger entry.
- `entry_kind__in` CreditEntryKind[], nullable: Only entries of any of these kinds. Repeat the parameter for each kind. Use this rather than several requests when a surface shows a mix ('where did my credits come from', say, which wants every kind except usage charges).
- `start_time` string, date-time, nullable
- `end_time` string, date-time, nullable
- `limit` integer: The number of items to return.
- `order_by` 'id' | 'occurred_at' | 'created_at' | 'updated_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

- PaginatedResponseCreditLedgerEntrySchema
  - `data` CreditLedgerEntrySchema[]: The list of ResponseItems.
    - `amount` number, required: Signed credits; charges are negative. In decimal credits.
    - `balance_after` number, required: In decimal credits.
    - `column_id` string, uuid, nullable, required
    - `description` string, nullable, required
    - `entry_kind` 'grant' | 'expiry' | 'pack_purchase' | 'charge' | 'refund' | 'referral' | 'adjustment', required: The kind of a credit ledger entry.
    - `id` string, uuid, required
    - `integration_id` string, uuid, nullable, required
    - `occurred_at` string, date-time, required
    - `provider_key` string, nullable, required
    - `run_id` string, uuid, nullable, required
    - `table_id` string, uuid, nullable, required
    - `unit_price` number, nullable, required: In decimal credits.
    - `units` integer, nullable, 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/4a6bd71e3f02?raw)