> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rebelfi.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List Recipients

> GET /v1/ramp/recipients — List all recipients with KYB status and volume summaries

<Note>
  **Endpoint:** `GET https://api.rebelfi.io/v1/ramp/recipients`
</Note>

List all recipients for your organization, including their KYB status, account counts, and volume summaries.

### Query Parameters

| Field      | Type      | Required | Description                                  |
| ---------- | --------- | -------- | -------------------------------------------- |
| `page`     | `integer` | No       | Page number (default: `1`)                   |
| `per_page` | `integer` | No       | Results per page (default: `20`, max: `100`) |

### Example Request

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "https://api.rebelfi.io/v1/ramp/recipients?page=1&per_page=20" \
    -H "x-api-key: your_api_key"
  ```

  ```typescript SDK theme={null}
  const recipients = await client.ramp.listRecipients({
    page: 1,
    perPage: 20
  });
  ```
</CodeGroup>

### Example Response

```json theme={null}
{
  "data": [
    {
      "id": 1,
      "name": "OnEdge",
      "type": "business",
      "external_id": "ref-123",
      "kyb_status": "approved",
      "onramp_account_count": 1,
      "offramp_account_count": 2,
      "total_volume_usd": "150000.00",
      "transaction_count": 45,
      "created_at": "2025-06-01T12:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total": 1
  }
}
```

### Response Fields

| Field                          | Type      | Description                   |
| ------------------------------ | --------- | ----------------------------- |
| `data`                         | `array`   | List of recipient objects     |
| `data[].id`                    | `number`  | Recipient identifier          |
| `data[].name`                  | `string`  | Recipient name                |
| `data[].type`                  | `string`  | Recipient type                |
| `data[].external_id`           | `string?` | Your external reference ID    |
| `data[].kyb_status`            | `string`  | KYB verification status       |
| `data[].onramp_account_count`  | `number`  | Number of on-ramp accounts    |
| `data[].offramp_account_count` | `number`  | Number of off-ramp accounts   |
| `data[].total_volume_usd`      | `string`  | Total volume in USD           |
| `data[].transaction_count`     | `number`  | Total number of transactions  |
| `data[].created_at`            | `string`  | Creation timestamp (ISO 8601) |
| `pagination.page`              | `number`  | Current page number           |
| `pagination.per_page`          | `number`  | Results per page              |
| `pagination.total`             | `number`  | Total number of recipients    |

<Info>
  Results are paginated. Use the `page` and `per_page` query parameters to navigate through large result sets.
</Info>