Admin

List all credits

Retrieve a list of 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

Query parameters

limitnumber nullable
pagenumber nullable
order_by'asc' | 'desc'
sort_bystring
include_archived'true' | 'false'
skip_pagination'true' | 'false'
user_idstring uuid
team_idstring uuid
type'DEBIT' | 'CREDIT'
reasonstring
entity_typestring
entity_idstring uuid
fetch_all'true' | 'false'
credit_type'FUNDED' | 'PROMOTIONAL' | 'REFERRAL' | 'REFUND' | 'MANUAL' | 'BONUS'
status'posted' | 'held' | 'released'

Response

Credits retrieved successfully

total_pagesnumber required
current_pagenumber required
next_pagenumber nullable required
previous_pagenumber nullable required
total_recordsnumber required

Example response

{
  "records": [
    {
      "amount": 280,
      "type": "CREDIT",
      "reason": "referral_commission",
      "notes": "Commission for article #123",
      "entity": "order_items",
      "entity_id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Changes

No recorded changes to this operation across all 3 revisions of this API.