---
title: "List recurring donations"
description: "List all your recurring donations."
canonical: https://www.charitips.com/docs/api-reference/list-recurring-donations
---

# List recurring donations

`GET /v1/recurring-donations`

List all your recurring donations.

**Authentication**: Bearer access token.

## Parameters

- `limit` (number): The max number of items to return.
- `cursor` (string): The id of the last item from the previous page. Used to fetch the next page.
- `createdAt_lt` (string (date-time)): Format: YYYY-MM-DDTHH:MM:SSZ.
- `createdAt_lte` (string (date-time)): Format: YYYY-MM-DDTHH:MM:SSZ.
- `createdAt_gt` (string (date-time)): Format: YYYY-MM-DDTHH:MM:SSZ.
- `createdAt_gte` (string (date-time)): Format: YYYY-MM-DDTHH:MM:SSZ.
- `campaignId` (string, UUID): Id of one your campaigns
- `status` (string): Status of your recurring donations One of `PENDING`, `ACTIVE`, `PAUSED`, `CANCELED`.
- `donorId` (string, UUID): Id of the donor.
- `includeMetrics` (boolean): Include metrics
- `includeCharity` (boolean): Include charity
- `accountId` (string, UUID): Id of the account. Only useful for Platform customers to filter recurring donations by child accounts.

## Response 200

- `recurringDonationId` (string, required)
- `type` (RecurringDonationType, required) One of `FREQUENCY`, `MANUAL`.
- `amountType` (RecurringDonationAmountType, required) One of `FIXED_AMOUNT`, `RATE`.
- `status` (RecurringDonationStatus, required) One of `PENDING`, `ACTIVE`, `PAUSED`, `CANCELED`.
- `hasBeenCharged` (boolean, required)
- `feeType` (FeeType, required) One of `EXCLUDED`, `INCLUDED`.
- `amount` (integer (int64), required)
- `rate` (number)
- `baseAmount` (integer (int64))
- `withRounding` (boolean, required)
- `frequency` (string)
- `secret` (string, required)
- `externalId` (string)
- `uniqueExternalId` (string)
- `sendingMode` (CampaignSendingMode, required) One of `MANUAL`, `EMAIL`, `PHYSICAL`, `SLACK`, `POSTAL`.
- `sendingDate` (string (date-time))
- `sendingStatus` (DonationSendingStatus, required) One of `PENDING`, `FAILED`, `DONE`.
- `lastReminderId` (string)
- `message` (string)
- `reminderMessage` (string)
- `from` (string)
- `language` (Language, required) One of `fr`, `en`.
- `accountId` (string, required)
- `campaignId` (string, required)
- `charityId` (string)
- `donorId` (string, required)
- `createdAt` (string (date-time), required)
- `updatedAt` (string (date-time), required)

## Errors

- 400 `A field is missing, has the wrong type, or is not part of the request schema.`: `message` lists every problem. Unknown fields are rejected, not ignored: remove them rather than sending extra data. See https://www.charitips.com/docs/api-reference/errors.md.
- 401 `Unauthorized`: The access token is missing, expired or invalid. Create a new one with your client id and secret, send it as `Authorization: Bearer <accessToken>`, then retry once. Sandbox tokens only work on api.sandbox.charitips.com. See https://www.charitips.com/docs/get-started/authentication.md.
- 403 `Account closed`: The account behind these credentials is closed: no token is issued and every call is refused, reads included. Contact Charitips to reopen it. See https://www.charitips.com/docs/api-reference/troubleshooting.md#calls-answer-403-account-not-active-account-not-validated-or-account-closed.

## Example

```bash
curl -X GET https://api.sandbox.charitips.com/v1/recurring-donations \
  -H "Authorization: Bearer $CHARITIPS_TOKEN"
```

```javascript
const response = await fetch('https://api.sandbox.charitips.com/v1/recurring-donations', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.CHARITIPS_TOKEN}`,
  },
});
if (!response.ok) throw new Error(`${response.status} ${await response.text()}`);
const data = await response.json();
```

```python
import os, requests

response = requests.get(
    "https://api.sandbox.charitips.com/v1/recurring-donations",
    headers={"Authorization": f"Bearer {os.environ['CHARITIPS_TOKEN']}"},
)
response.raise_for_status()
data = response.json()
```

## Response example (200, placeholder values)

```json
[
  {
    "recurringDonationId": "<recurringDonationId>",
    "type": "FREQUENCY",
    "amountType": "FIXED_AMOUNT",
    "status": "PENDING",
    "hasBeenCharged": false,
    "feeType": "EXCLUDED",
    "amount": 2000,
    "rate": 1
  }
]
```