---
title: "Retrieve credit balances"
method: GET
path: "/v1/finder/credits"
tags: ["RecruitAffiliates.ai"]
---

# Retrieve credit balances

`GET /v1/finder/credits`

## Request

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

Email and search credits: this period's allowance, what's spent (net of refunds), what's left and when it resets.

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

## Response `200`

Balances

- FinderCredits
  - `object` 'finder_credits', required
  - `balances` FinderCreditBalance[], required
    - `kind` 'email' | 'search', required
    - `allowance` integer, nullable, required: This period's allowance. Null means no limit.
    - `spent` integer, required: Spent this period, net of refunds
    - `remaining` integer, nullable, required: Left, bonus credits included. Null means no limit.
    - `resets_at` string, date-time, required: ISO-8601, UTC

## 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)