---
title: "List all credits"
method: GET
path: "/admin/credits"
tags: ["Admin"]
---

# List all credits

`GET /admin/credits`

## Request

- Base URL: `https://api.presscart.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.presscart.com/admin/credits`
- Auth: HTTP bearer

Retrieve a list of all credits.

## Query parameters

- `limit` number, nullable
- `page` number, nullable
- `order_by` 'asc' | 'desc'
- `sort_by` string
- `include_archived` 'true' | 'false'
- `skip_pagination` 'true' | 'false'
- `filters` object
  - `user_id` string, uuid
  - `team_id` string, uuid
  - `type` 'DEBIT' | 'CREDIT'
  - `reason` string
  - `entity_type` string
  - `entity_id` string, uuid
  - `fetch_all` 'true' | 'false'
  - `credit_type` 'FUNDED' | 'PROMOTIONAL' | 'REFERRAL' | 'REFUND' | 'MANUAL' | 'BONUS'
  - `status` 'posted' | 'held' | 'released'

## Response `200`

Credits retrieved successfully

- object
  - `total_pages` number, required
  - `current_page` number, required
  - `next_page` number, nullable, required
  - `previous_page` number, nullable, required
  - `records` AdminLedgerCredit[], required
    - `id` string, uuid, required
    - `amount` number, required
    - `type` 'DEBIT' | 'CREDIT', required
    - `reason` string, nullable, required
    - `notes` string, nullable, required
    - `entity` string, nullable, required
    - `entity_id` string, nullable, required
    - `user_id` string, uuid, required
    - `team_id` string, uuid, nullable, required
    - `created_by` string, uuid, nullable, required
    - `created_at` union, required
      - string, nullable
      - string
      - unknown
    - `updated_at` union, required
      - string, nullable
      - string
      - unknown
    - `deleted_at` union, required
      - string, nullable
      - string
      - unknown
    - `credit_type` 'FUNDED' | 'PROMOTIONAL' | 'REFERRAL' | 'REFUND' | 'MANUAL' | 'BONUS', nullable, required
    - `expires_at` union, required
      - string, nullable
      - string
      - unknown
    - `transaction_id` string, uuid, required
    - `legs` object[], required
      - `credit_type` 'FUNDED' | 'PROMOTIONAL' | 'REFERRAL' | 'REFUND' | 'MANUAL' | 'BONUS', nullable, required
      - `direction` 'DEBIT' | 'CREDIT', required
      - `amount` number, required
    - `status` 'PENDING' | 'POSTED' | 'ARCHIVED', required
    - `external_source` string, nullable, required
    - `order_id` string, uuid, nullable, required
    - `order_reference_number` string, nullable, required
    - `created_by_name` string, nullable, required
  - `total_records` number, required

---

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