Donorbox
App · 10 actions
Read your Donorbox fundraising: campaigns, donations, donors, recurring plans and event tickets, and start workflows when a donation, donor, plan or ticket purchase comes in.
Actions
| Action | What it does |
|---|---|
| Get campaign | Get one campaign with its goal, amount raised so far and number of donations. |
| Get donation | Get one donation with its donor, campaign, amount, fees, refunds, how often the donor gives ('frequency': one-time, monthly and so on) and answers to your form's questions. |
| Get donor | Get one donor with their contact details, number of donations, last donation date and total given in each currency. |
| List campaigns | List your fundraising campaigns with their goal, amount raised and number of donations. |
| List donations | List donations with their donor, campaign, amount, fees and answers, filtered by campaign, donor, date or amount. |
| List donors | List donors with their contact details, number of donations and total given, optionally by email or name. |
| List event tickets | List event tickets with their type, price, event and the buyer's details, or only refunded ones. |
| List events | List your ticketed events with the amount raised and tickets sold. |
| List recurring plans | List recurring donation plans with their donor, campaign, amount, frequency, status and next donation date, filtered by campaign, donor or start date. |
| List ticket purchases | List event ticket purchases (orders) with their amount, refunds, event and tickets, by payment status. |
Get campaign
Get one campaign with its goal, amount raised so far and number of donations.
Inputs
- Campaign
campaign_idtextRequired - The campaign. Pick one, or give its id.
Outputs
campaignobject- The campaign
Example output
{
"campaign": {
"created_at": "2026-03-01T22:30:55.620Z",
"currency": "usd",
"donations_count": 66,
"formatted_goal_amount": "$10,000",
"formatted_total_raised": "$2,000",
"goal_amt": "10000.0",
"id": 1,
"name": "Spring Appeal",
"slug": "spring-appeal",
"total_raised": "2000.0",
"updated_at": "2026-03-02T09:12:00.000Z"
}
}Get donation
Get one donation with its donor, campaign, amount, fees, refunds, how often the donor gives ('frequency': one-time, monthly and so on) and answers to your form's questions.
Inputs
- Donation ID
donation_idtextRequired - The donation's id, from 'List donations' or a trigger.
Outputs
donationobject- The donation
Example output
{
"donation": {
"amount": "100.0",
"amount_refunded": "0.0",
"anonymous_donation": false,
"campaign": {
"id": 1,
"name": "Spring Appeal"
},
"comment": "Keep up the good work",
"converted_amount": "100.0",
"converted_currency": "USD",
"currency": "USD",
"designation": "General Fund",
"donation_date": "2026-03-21T17:54:13.432Z",
"donation_type": "stripe",
"donor": {
"address": "123 6th St.",
"city": "Melbourne",
"country": "US",
"email": "john@example.com",
"employer": "Acme",
"first_name": "John",
"id": 59,
"last_name": "Doe",
"name": "John Doe",
"occupation": "Engineer",
"state": "FL",
"zip_code": "32904"
},
"first_recurring_donation": false,
"formatted_amount": "$100",
"formatted_amount_refunded": "$0",
"formatted_converted_amount": "$100",
"formatted_processing_fee": "$0.59",
"frequency": "one-time",
"gift_aid": false,
"id": 1,
"join_mailing_list": true,
"processing_fee": 0.59,
"questions": [
{
"answer": "Yes",
"question": "Would you like to volunteer?",
"question_type": "radiobutton"
}
],
"recurring": false,
"status": "paid",
"utm_campaign": "spring",
"utm_content": "button",
"utm_medium": "email",
"utm_source": "newsletter",
"utm_term": "donate"
}
}Get donor
Get one donor with their contact details, number of donations, last donation date and total given in each currency.
Inputs
- Donor ID
donor_idtextRequired - The donor's id, from 'List donors', a donation's donor or a trigger.
Outputs
donorobject- The donor
Example output
{
"donor": {
"address": "123 6th St.",
"city": "Melbourne",
"comment": "Prefers email",
"country": "US",
"created_at": "2026-02-20T14:01:35.597Z",
"donations_count": 2,
"email": "john@example.com",
"employer": "Acme",
"first_name": "John",
"id": 59,
"last_donation_at": "2026-03-21T17:54:13.432Z",
"last_name": "Doe",
"occupation": "Engineer",
"phone": "123456789",
"state": "FL",
"total": [
{
"currency": "usd",
"value": 200.0
}
],
"updated_at": "2026-03-21T17:54:13.432Z",
"zip_code": "32904"
}
}List campaigns
List your fundraising campaigns with their goal, amount raised and number of donations. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Campaign name
nametext - Only the campaign with this exact name.
- Order
ordertext - Newest or oldest first. Defaults to newest first.One of:
desc(Newest first (default)),asc(Oldest first). - Page
pagenumber - Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.
- Page size
per_pagenumber - How many to return, 1 to 100. Donorbox's default is 50.From 1 to 100.
Outputs
campaignslist- The campaigns
countnumber- How many came back on this page
next_pagenumber- The page to ask for next, or 0 when this page was not full and there are no more
pagenumber- The page read, from 1
Example output
{
"campaigns": [
{
"created_at": "2026-03-01T22:30:55.620Z",
"currency": "usd",
"donations_count": 66,
"formatted_goal_amount": "$10,000",
"formatted_total_raised": "$2,000",
"goal_amt": "10000.0",
"id": 1,
"name": "Spring Appeal",
"slug": "spring-appeal",
"total_raised": "2000.0",
"updated_at": "2026-03-02T09:12:00.000Z"
}
],
"count": 1,
"next_page": 0,
"page": 1
}List donations
List donations with their donor, campaign, amount, fees and answers, filtered by campaign, donor, date or amount. Each says how often its donor gives ('frequency': one-time, monthly and so on). Gets one page; to see more, run it again with the next page it gives.
Inputs
- Campaign
campaign_idtext - Only those for this campaign.
- Donor ID
donor_idtext - Only those from this donor, by their Donorbox id.
- Donor email
emailtext - Only those from the donor with this email address.
- Donor first name
first_nametext - Only those from donors with this first name.
- Donor last name
last_nametext - Only those from donors with this last name.
- From
date_fromdate - Only donations made on or after this date.
- Until
date_todate - Only donations made before this date.
- Minimum amount
amount_minnumber - Only donations of at least this amount.At least 0.
- Maximum amount
amount_maxnumber - Only donations of at most this amount.At least 0.
- Amount currency
amount_currencytext - The currency the minimum and maximum are in, as a three-letter code such as usd or eur. Defaults to usd.
- Order
ordertext - Newest or oldest first. Defaults to newest first.One of:
desc(Newest first (default)),asc(Oldest first). - Page
pagenumber - Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.
- Page size
per_pagenumber - How many to return, 1 to 100. Donorbox's default is 50.From 1 to 100.
Outputs
countnumber- How many came back on this page
donationslist- The donations
next_pagenumber- The page to ask for next, or 0 when this page was not full and there are no more
pagenumber- The page read, from 1
Example output
{
"count": 1,
"donations": [
{
"amount": "100.0",
"amount_refunded": "0.0",
"anonymous_donation": false,
"campaign": {
"id": 1,
"name": "Spring Appeal"
},
"comment": "Keep up the good work",
"converted_amount": "100.0",
"converted_currency": "USD",
"currency": "USD",
"designation": "General Fund",
"donation_date": "2026-03-21T17:54:13.432Z",
"donation_type": "stripe",
"donor": {
"address": "123 6th St.",
"city": "Melbourne",
"country": "US",
"email": "john@example.com",
"employer": "Acme",
"first_name": "John",
"id": 59,
"last_name": "Doe",
"name": "John Doe",
"occupation": "Engineer",
"state": "FL",
"zip_code": "32904"
},
"first_recurring_donation": false,
"formatted_amount": "$100",
"formatted_amount_refunded": "$0",
"formatted_converted_amount": "$100",
"formatted_processing_fee": "$0.59",
"frequency": "one-time",
"gift_aid": false,
"id": 1,
"join_mailing_list": true,
"processing_fee": 0.59,
"questions": [
{
"answer": "Yes",
"question": "Would you like to volunteer?",
"question_type": "radiobutton"
}
],
"recurring": false,
"status": "paid",
"utm_campaign": "spring",
"utm_content": "button",
"utm_medium": "email",
"utm_source": "newsletter",
"utm_term": "donate"
}
],
"next_page": 0,
"page": 1
}List donors
List donors with their contact details, number of donations and total given, optionally by email or name. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Email
emailtext - Only the donor with this email address.
- First name
first_nametext - Only donors with this first name.
- Last name
last_nametext - Only donors with this last name.
- Order
ordertext - Newest or oldest first. Defaults to newest first.One of:
desc(Newest first (default)),asc(Oldest first). - Page
pagenumber - Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.
- Page size
per_pagenumber - How many to return, 1 to 100. Donorbox's default is 50.From 1 to 100.
Outputs
countnumber- How many came back on this page
donorslist- The donors
next_pagenumber- The page to ask for next, or 0 when this page was not full and there are no more
pagenumber- The page read, from 1
Example output
{
"count": 1,
"donors": [
{
"address": "123 6th St.",
"city": "Melbourne",
"comment": "Prefers email",
"country": "US",
"created_at": "2026-02-20T14:01:35.597Z",
"donations_count": 2,
"email": "john@example.com",
"employer": "Acme",
"first_name": "John",
"id": 59,
"last_donation_at": "2026-03-21T17:54:13.432Z",
"last_name": "Doe",
"occupation": "Engineer",
"phone": "123456789",
"state": "FL",
"total": [
{
"currency": "usd",
"value": 200.0
}
],
"updated_at": "2026-03-21T17:54:13.432Z",
"zip_code": "32904"
}
],
"next_page": 0,
"page": 1
}List event tickets
List event tickets with their type, price, event and the buyer's details, or only refunded ones. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Only refunded tickets
refunded_onlytrue/false - Turn on to list only tickets that were refunded.
- Order
ordertext - Newest or oldest first. Defaults to newest first.One of:
desc(Newest first (default)),asc(Oldest first). - Page
pagenumber - Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.
- Page size
per_pagenumber - How many to return, 1 to 100. Donorbox's default is 50.From 1 to 100.
Outputs
countnumber- How many came back on this page
next_pagenumber- The page to ask for next, or 0 when this page was not full and there are no more
pagenumber- The page read, from 1
ticketslist- The tickets
Example output
{
"count": 1,
"next_page": 0,
"page": 1,
"tickets": [
{
"currency": "USD",
"event": {
"id": 123123,
"name": "Concert for a Cure"
},
"free_ticket": false,
"id": 675645,
"price": 1.04,
"price_formatted": "$1.04",
"ticket_type": {
"fair_market_value": 0.4,
"fair_market_value_formatted": "$0.40",
"id": 15132,
"name": "General Admission",
"tax_amount": 0.04,
"tax_amount_formatted": "$0.04",
"tax_deductible_amount": 0.6,
"tax_deductible_amount_formatted": "$0.60"
},
"transaction": {
"address": "4801 Kenmore Ave",
"city": "Alexandria",
"country": "US",
"currency": "USD",
"email": "jo@example.com",
"first_name": "Jo",
"free_purchase": false,
"full_name": "Jo Bloggs",
"id": 212321,
"last_name": "Bloggs",
"phone": "8509608580",
"price": 1.04,
"price_formatted": "$1.04",
"purchase_date": "2026-03-04T16:50:33Z",
"state": "Virginia",
"status": "paid",
"supporter_id": 9635959,
"zip": "22304"
}
}
]
}List events
List your ticketed events with the amount raised and tickets sold. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Order
ordertext - Newest or oldest first. Defaults to newest first.One of:
desc(Newest first (default)),asc(Oldest first). - Page
pagenumber - Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.
- Page size
per_pagenumber - How many to return, 1 to 100. Donorbox's default is 50.From 1 to 100.
Outputs
countnumber- How many came back on this page
eventslist- The events
next_pagenumber- The page to ask for next, or 0 when this page was not full and there are no more
pagenumber- The page read, from 1
Example output
{
"count": 1,
"events": [
{
"created_at": "2026-03-03T20:44:18Z",
"currency": "usd",
"donations_count": 0,
"formatted_total_raised": "$0",
"id": 123123,
"name": "Concert for a Cure",
"slug": "concert-for-a-cure",
"tickets_count": 8,
"total_raised": 0,
"updated_at": "2026-03-23T06:19:43Z"
}
],
"next_page": 0,
"page": 1
}List recurring plans
List recurring donation plans with their donor, campaign, amount, frequency, status and next donation date, filtered by campaign, donor or start date. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Campaign
campaign_idtext - Only those for this campaign.
- Donor ID
donor_idtext - Only those from this donor, by their Donorbox id.
- Donor email
emailtext - Only those from the donor with this email address.
- Started from
date_fromdate - Only plans started on or after this date.
- Started until
date_todate - Only plans started before this date.
- Order
ordertext - Newest or oldest first. Defaults to newest first.One of:
desc(Newest first (default)),asc(Oldest first). - Page
pagenumber - Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.
- Page size
per_pagenumber - How many to return, 1 to 100. Donorbox's default is 50.From 1 to 100.
Outputs
countnumber- How many came back on this page
next_pagenumber- The page to ask for next, or 0 when this page was not full and there are no more
pagenumber- The page read, from 1
planslist- The recurring plans
Example output
{
"count": 1,
"next_page": 0,
"page": 1,
"plans": [
{
"amount": "10.0",
"campaign": {
"id": 1,
"name": "Spring Appeal"
},
"donor": {
"address": "123 6th St.",
"city": "Melbourne",
"country": "US",
"email": "john@example.com",
"employer": "Acme",
"first_name": "John",
"id": 59,
"last_name": "Doe",
"name": "John Doe",
"occupation": "Engineer",
"state": "FL",
"zip_code": "32904"
},
"formatted_amount": "$10",
"id": 168,
"last_donation_date": "2026-03-21T05:00:00.000Z",
"next_donation_date": "2026-04-21",
"payment_method": "Stripe",
"started_at": "2026-03-21",
"status": "active",
"type": "monthly"
}
]
}List ticket purchases
List event ticket purchases (orders) with their amount, refunds, event and tickets, by payment status. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Payment status
payment_statustext - Which purchases to list. Defaults to succeeded.One of:
succeeded(Succeeded (default)),pending,failed,refunded. - Order
ordertext - Newest or oldest first. Defaults to newest first.One of:
desc(Newest first (default)),asc(Oldest first). - Page
pagenumber - Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.
- Page size
per_pagenumber - How many to return, 1 to 100. Donorbox's default is 50.From 1 to 100.
Outputs
countnumber- How many came back on this page
next_pagenumber- The page to ask for next, or 0 when this page was not full and there are no more
pagenumber- The page read, from 1
purchaseslist- The ticket purchases
Example output
{
"count": 1,
"next_page": 0,
"page": 1,
"purchases": [
{
"amount": 1.04,
"amount_formatted": "$1.04",
"amount_refunded": 0,
"currency": "USD",
"date": "2026-03-04T16:50:33Z",
"event": {
"id": 123123,
"name": "Concert for a Cure"
},
"id": 212321,
"status": "paid",
"supporter_id": 9635959,
"tickets": [
{
"currency": "USD",
"free_ticket": false,
"id": 675645,
"price": 1.04,
"price_formatted": "$1.04",
"ticket_type": {
"fair_market_value": 0.4,
"fair_market_value_formatted": "$0.40",
"id": 15132,
"name": "General Admission",
"tax_amount": 0.04,
"tax_amount_formatted": "$0.04",
"tax_deductible_amount": 0.6,
"tax_deductible_amount_formatted": "$0.60"
}
}
],
"tickets_count": 1
}
]
}