---
title: "List credit ledger entries"
method: GET
path: "/v1/finder/credits/ledger"
tags: ["RecruitAffiliates.ai"]
---

# List credit ledger entries

`GET /v1/finder/credits/ledger`

## Request

- Base URL: `https://api.affiliaterail.com`
- URL: `https://api.affiliaterail.com/v1/finder/credits/ledger`
- Auth: HTTP bearer

Every credit spent, refunded or granted, newest first. A refund names the spend it gives back in `refund_of`.

**Scope:** `finder:read` (or `finder:write`)

## Query parameters

- `kind` 'email' | 'search'
- `limit` string: 1 to 100, default 25
- `cursor` string: `next_cursor` from the previous page, with the same filters

## Response `200`

Ledger entries

- FinderCreditEntryPage
  - `data` FinderCreditEntry[], required
    - `id` string, required: Prefixed id (`fce_…`)
    - `object` 'finder_credit_entry', required
    - `kind` 'email' | 'search', required
    - `amount` integer, required: Negative for a spend, positive for a refund or a bonus
    - `reason` string, required
    - `related_id` string, nullable, required: The prospect a reveal was for, or the search
    - `refund_of` string, nullable, required: On a refund, the entry it gives back
    - `created_at` string, date-time, required: ISO-8601, UTC
  - `has_more` boolean, required: True when `next_cursor` fetches more
  - `total_count` integer, required: Every object matching the filters, ignoring the cursor
  - `next_cursor` string, nullable, required: Pass as `cursor` with the same filters to get the next page. Null on the last page.

## Other responses

- `400`: Invalid request
- `401`: Missing or unknown API key
- `402`: The organization's Recruit Affiliates plan does not include the API
- `403`: Key lacks the required scope
- `404`: No such object in your organization
- `409`: In conflict with the object's state, or the same idempotent request is still running
- `422`: The request was understood and refused
- `429`: Rate limited, by key or by organization: see Retry-After and X-RateLimit-Scope
- `501`: Not available to a test key (`sandbox_no_send`)

---

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