Sign in

v1

latestOpenAPI 3.1.02026-07-26202027.9 KB
Recipients

List recipients

Returns a paginated list of recipients for your organization. Each recipient includes lifetime earnings totals (paid, pending, held, in cents) and a summary of their current payment method.

get/recipients

Query parameters

limitinteger

Maximum number of results to return (max 100, default 100).

offsetinteger

Number of results to skip for pagination (default 0).

Response

A paginated list of recipients.

Example response

{
  "data": [
    {
      "earnings": {
        "paid": 125000,
        "pending": 15000,
        "held": 5000
      },
      "paymentMethod": {
        "method": "ACH",
        "currency": "USD"
      }
    }
  ]
}