Skip to main content
GET
List donations

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Query Parameters

person_id
string

Only gifts from this person.

campaign_id
string

Only gifts to this campaign.

status
enum<string>

Only completed gifts count towards a campaign, a donor's giving or the donors list.

Available options:
pending,
completed,
failed,
refunded
donation_type
enum<string>
Available options:
one_time,
recurring,
post_adoption_bump,
upsell
from
string<date>

Gifts on or after this day.

to
string<date>

Gifts on or before this day.

amount_cents_min
number

Gifts of at least this many cents.

amount_cents_max
number

Gifts of at most this many cents.

currency
string

Currency codes containing this text.

payment_gateway
string

Gateways containing this text.

created_at_from
string

Recorded on or after this day or moment.

created_at_to
string

Recorded on or before this moment. The recorded time is a timestamp, so a bare date here ends at the start of that day: to include the whole day, send the next day or a full timestamp.

updated_at_from
string

Last changed on or after this day or moment.

updated_at_to
string

Last changed on or before this moment. As with created_at_to, a bare date ends at the start of that day.

sort
enum<string>
default:donated_at
Available options:
donated_at,
amount_cents,
status,
donation_type,
created_at,
updated_at
dir
enum<string>
default:desc
Available options:
asc,
desc
limit
integer
default:25

How many to return. 25 unless you say, 100 at most.

Required range: 1 <= x <= 100
offset
integer
default:0

How many to skip, for the next page.

Required range: x >= 0

Response

One page of donations.

results
object[]
required
limit
integer
required
offset
integer
required
has_more
boolean
required

Whether there is another page after this one.

total
integer
required

How many donations match in all.

summary
object
required

Over every matching donation, not only this page.