### GET /api/v1/plans Source: https://github.com/donorbox/donorbox-api/blob/master/README.md Retrieves a list of all donation plans associated with the account. ```APIDOC ## GET /api/v1/plans ### Description Returns a list of all donation plans, including campaign details, donor information, and payment status. ### Method GET ### Endpoint /api/v1/plans ### Response #### Success Response (200) - **plans** (array) - List of donation plan objects. #### Response Example [ { "id": 168, "campaign": { "id": 61, "name": "Save the jungle campaign" }, "donor": { "id": 384, "name": "Bruce Waine", "email": "bruce@email.com" }, "type": "monthly", "amount": "10.0", "status": "active" } ] ``` -------------------------------- ### GET /api/v1/events Source: https://github.com/donorbox/donorbox-api/blob/master/README.md Retrieves a list of all campaigns or events. ```APIDOC ## GET /api/v1/events ### Description Returns a list of all campaigns/events with their financial totals and ticket counts. ### Method GET ### Endpoint /api/v1/events ### Response #### Success Response (200) - **events** (array) - List of event objects. #### Response Example [ { "id": 123123, "name": "Concert for a Cure", "total_raised": 0, "donations_count": 0 } ] ``` -------------------------------- ### GET /api/v1/donations Source: https://github.com/donorbox/donorbox-api/wiki/Pagination Retrieve a paginated list of donations. ```APIDOC ## GET /api/v1/donations.json ### Description Retrieves a list of donations with default pagination of 50 records per page. ### Method GET ### Endpoint https://donorbox.org/api/v1/donations.json ### Parameters #### Query Parameters - **page** (integer) - Optional - The page number to retrieve. ### Request Example GET https://donorbox.org/api/v1/donations.json?page=2 ### Response #### Success Response (200) - **donations** (array) - A list of donation objects. #### Response Example { "donations": [ { "id": 101, "amount": "50.00" } ] } ``` -------------------------------- ### GET /api/v1/tickets Source: https://github.com/donorbox/donorbox-api/blob/master/README.md Retrieves information for all tickets sold. ```APIDOC ## GET /api/v1/tickets ### Description Returns a list of all tickets, including ticket type details, associated event, and transaction information. ### Method GET ### Endpoint /api/v1/tickets ### Response #### Success Response (200) - **tickets** (array) - List of ticket objects. #### Response Example [ { "id": 123456, "price": 1.04, "ticket_type": { "name": "General Admission" }, "event": { "name": "Concert for a Cure" } } ] ``` -------------------------------- ### GET /api/v1/plans Source: https://github.com/donorbox/donorbox-api/blob/master/README.md Retrieve and filter plans using donor details, campaign information, or date ranges. ```APIDOC ## GET /api/v1/plans ### Description Retrieve a list of plans with optional filtering by donor email, campaign, or date range. ### Method GET ### Endpoint /api/v1/plans ### Parameters #### Query Parameters - **email** (string) - Optional - Filter by donor email - **date_from** (string) - Optional - Start date (YYYY-mm-dd) - **date_to** (string) - Optional - End date (YYYY-mm-dd) - **campaign_id** (integer) - Optional - Filter by campaign ID - **campaign_name** (string) - Optional - Filter by campaign name - **donor_id** (integer) - Optional - Filter by donor ID - **first_name** (string) - Optional - Filter by donor first name - **last_name** (string) - Optional - Filter by donor last name ### Request Example GET /api/v1/plans?email=test@example.com&campaign_id=123 ### Response #### Success Response (200) - **plans** (array) - List of plan objects ``` -------------------------------- ### GET /api/v1/campaigns Source: https://context7.com/donorbox/donorbox-api/llms.txt Retrieve a list of all fundraising campaigns, including details like goal amounts, currency, and total raised. ```APIDOC ## GET /api/v1/campaigns ### Description Retrieve information about all your fundraising campaigns including name, currency, goal amount, total raised, and donation count. ### Method GET ### Endpoint https://donorbox.org/api/v1/campaigns ### Parameters #### Query Parameters - **id** (integer) - Optional - Filter by campaign ID - **name** (string) - Optional - Filter by campaign name ### Response #### Success Response (200) - **id** (integer) - Campaign ID - **name** (string) - Campaign name - **goal_amt** (string) - Goal amount - **total_raised** (string) - Total amount raised #### Response Example [ { "id": 1, "name": "Donorbox New Campaign", "goal_amt": "10000.0", "total_raised": "2000.0" } ] ``` -------------------------------- ### GET /api/v1/donations Source: https://github.com/donorbox/donorbox-api/wiki/Filters Retrieve a list of donations with support for filtering by campaign, pagination, and sorting. ```APIDOC ## GET /api/v1/donations ### Description Retrieve donation records from your account. Supports filtering by campaign, limiting results per page, and ordering the results. ### Method GET ### Endpoint https://donorbox.org/api/v1/donations ### Parameters #### Query Parameters - **campaign_id** (integer) - Optional - Filter donations by a specific campaign ID. - **per_page** (integer) - Optional - Number of donations to return per page. - **order** (string) - Optional - Sort order, either 'asc' (ascending) or 'desc' (descending). ### Request Example GET https://donorbox.org/api/v1/donations?order=asc&per_page=10&campaign_id=123 ### Response #### Success Response (200) - **donations** (array) - List of donation objects. #### Response Example { "donations": [ { "id": 12345, "amount": "50.00", "campaign_id": 123 } ] } ``` -------------------------------- ### GET /api/v1/campaigns Source: https://github.com/donorbox/donorbox-api/wiki/Endpoints Retrieves a list of all campaigns associated with the organization. ```APIDOC ## GET /api/v1/campaigns ### Description Fetch a list of all campaigns created within the organization account. ### Method GET ### Endpoint https://donorbox.org/api/v1/campaigns ### Response #### Success Response (200) - **campaigns** (array) - List of campaign objects including id, name, slug, and financial metrics. #### Response Example [ { "id": 1, "name": "Donorbox New Campaign", "slug": "donorbox-new-campaign", "currency": "usd", "goal_amt": "10000.0", "total_raised": "2000.0", "donations_count": 66 } ] ``` -------------------------------- ### GET /api/v1/donors Source: https://github.com/donorbox/donorbox-api/wiki/Pagination Retrieve a paginated list of donors. ```APIDOC ## GET /api/v1/donors.json ### Description Retrieves a list of donors with default pagination of 50 records per page. ### Method GET ### Endpoint https://donorbox.org/api/v1/donors.json ### Parameters #### Query Parameters - **page** (integer) - Optional - The page number to retrieve. ### Request Example GET https://donorbox.org/api/v1/donors.json?page=2 ### Response #### Success Response (200) - **donors** (array) - A list of donor objects. #### Response Example { "donors": [ { "id": 1, "name": "John Doe" } ] } ``` -------------------------------- ### GET /api/v1/events Source: https://context7.com/donorbox/donorbox-api/llms.txt Retrieve a list of all events. Includes event name, currency, total raised, and ticket counts. ```APIDOC ## GET /api/v1/events ### Description Retrieve all events including name, currency, total raised, and ticket counts. ### Method GET ### Endpoint /api/v1/events ### Parameters None ### Request Example ```bash curl -X GET \ --user "admin@nonprofit.org:dk_live_abc123xyz" \ "https://donorbox.org/api/v1/events" ``` ### Response #### Success Response (200) - **events** (array) - A list of event objects. - **id** (integer) - The unique identifier for the event. - **name** (string) - The name of the event. - **slug** (string) - A URL-friendly identifier for the event. - **currency** (string) - The currency used for the event (e.g., "usd"). - **created_at** (string) - ISO 8601 timestamp when the event was created. - **updated_at** (string) - ISO 8601 timestamp when the event was last updated. - **total_raised** (number) - The total amount raised for the event. - **formatted_total_raised** (string) - The formatted total amount raised (e.g., "$0"). - **donations_count** (integer) - The number of donations received for the event. - **tickets_count** (integer) - The number of tickets sold for the event. #### Response Example ```json [ { "id": 123123, "name": "Concert for a Cure", "slug": "concert-for-a-cure", "currency": "usd", "created_at": "2023-10-03T20:44:18Z", "updated_at": "2023-10-23T06:19:43Z", "total_raised": 0, "formatted_total_raised": "$0", "donations_count": 0, "tickets_count": 8 } ] ``` ``` -------------------------------- ### Combine Donorbox API Filters Source: https://github.com/donorbox/donorbox-api/wiki/Filters Demonstrates how to combine multiple filters (campaign ID, per page, order) in a single API request to retrieve highly specific donation data. This allows for complex querying of donation records. The example shows a combination of order, per_page, and campaign_id filters. ```HTTP GET https://donorbox.org/api/v1/donations?order=asc&per_page=XX&campaign_id=XX ``` -------------------------------- ### GET /api/v1/donations Source: https://github.com/donorbox/donorbox-api/wiki/Endpoints Retrieves the donation history for the organization. ```APIDOC ## GET /api/v1/donations ### Description Retrieve all donations processed by the organization, including donor details and payment status. ### Method GET ### Endpoint https://donorbox.org/api/v1/donations ### Response #### Success Response (200) - **donations** (array) - List of donation objects containing amount, donor info, and payment metadata. #### Response Example [ { "id": 1, "amount": "100.0", "status": "paid", "donor": { "name": "John Doe", "email": "johndoeemail@hotmail.com" }, "donation_date": "2017-12-21T17:54:13.432Z" } ] ``` -------------------------------- ### GET /api/v1/donations Source: https://github.com/donorbox/donorbox-api/blob/master/README.md Retrieves a list of all donations for an organization. Supports filtering and pagination (details not provided in source). ```APIDOC ## GET /api/v1/donations ### Description Get all your organization's donations. ### Method GET ### Endpoint /api/v1/donations ### Parameters #### Query Parameters * **limit** (integer) - Optional - Number of donations to return per page. * **offset** (integer) - Optional - Number of donations to skip before starting to collect the result set. ### Request Example (No request body for GET requests) ### Response #### Success Response (200) Returns a JSON array of donation objects. The structure of the donation object may vary slightly depending on the payment processor (e.g., Stripe, PayPal). **Common Fields:** - **campaign** (object) - Information about the donation campaign. - **id** (integer) - The campaign ID. - **name** (string) - The campaign name. - **donor** (object) - Information about the donor. - **id** (integer) - The donor ID. - **name** (string) - The donor's full name. - **first_name** (string) - The donor's first name. - **last_name** (string) - The donor's last name. - **email** (string) - The donor's email address. - **address** (string) - The donor's street address. - **city** (string) - The donor's city. - **state** (string) - The donor's state or province. - **zip_code** (string) - The donor's zip or postal code. - **country** (string) - The donor's country. - **amount** (string) - The donation amount. - **formatted_amount** (string) - The formatted donation amount (e.g., "$100"). - **currency** (string) - The currency of the donation (e.g., "USD"). - **donation_type** (string) - The payment processor used (e.g., "stripe", "paypal"). - **donation_date** (string) - The date and time the donation was made (ISO 8601 format). - **status** (string) - The status of the donation (e.g., "paid"). - **comment** (string) - Any comment left by the donor. - **questions** (array) - An array of custom questions asked during the donation process and their answers. **Stripe Specific Fields:** - **stripe_charge_id** (string) - The Stripe charge ID. - **processing_fee** (number) - The processing fee charged by Stripe. **PayPal Specific Fields:** - **paypal_transaction_id** (string) - The PayPal transaction ID. #### Response Example (Stripe) ```json [ { "action": "new", "campaign": { "id": 1, "name": "Donorbox Campaign" }, "donor": { "id": 59, "name": "John Doe", "first_name": "John", "last_name": "Doe", "email": "johndoeemail@hotmail.com", "address":"123 6th St.", "address_line_2":"Lakeside Road", "city":"Melbourne", "state":"FL", "zip_code": "32904", "country":"US", "employer":null, "occupation":null }, "amount": "100.0", "formatted_amount": "$100", "converted_amount": "100.0", "formatted_converted_amount": "$100", "recurring": false, "first_recurring_donation": false, "amount_refunded": "0.0", "formatted_amount_refunded": "$0", "stripe_charge_id": "ch_1BF94aBku99FiTp3uJM5mSKw", "id": 1, "status": "paid", "donation_type": "stripe", "donation_date": "2017-12-21T17:54:13.432Z", "anonymous_donation": false, "gift_aid": false, "designation": "Designed Cause", "join_mailing_list": false, "comment": "thanks", "donating_company": null, "currency": "USD", "converted_currency": "USD", "utm_campaign": "google_ads", "utm_source": "Adwords", "utm_medium": "cpc", "utm_term": "nonprofit fundraising", "utm_content": "np1", "processing_fee": 0.59, "formatted_processing_fee": "$0.59", "address": "123 6th St.", "address_line_2": "Lakeside Road", "city": "Melbourne", "state": "FL", "zip_code": "32904", "country": "US", "employer": null, "occupation": null, "questions": [ { "question_type": "radiobutton", "question": "Would you like to volunteer?", "answer": "Yes" }, { "question_type": "text", "question": "Why are you donating", "answer": "I would like to help" }, { "question_type": "check", "question": "First/Last Name is correct?", "answer": true }, { "question_type": "dropdown", "question": "Would you like to showcase your donation", "answer": "Yes" } ] } ] ``` #### Response Example (PayPal) ```json [ { "campaign": { "id": 1, "name": "Donorbox Campaign" }, "donor": { "id": 59, "name": "John Doe", "first_name": "John", "last_name": "Doe", "email": "johndoeemail@hotmail.com", "address":"123 6th St.", "city":"Melbourne", "state":"FL", "zip_code": "32904", "country":"USA", "employer":null, "occupation":null }, "amount": "100.0", "formatted_amount": "$100", "converted_amount": "100.0", "formatted_converted_amount": "$100", "recurring": false, "first_recurring_donation": false, "amount_refunded": "0.0", "formatted_amount_refunded": "$0", "paypal_transaction_id": "RANDOMPAYPALID", "id": 1, "status": "paid", "donation_type": "paypal", "donation_date": "2017-12-21T17:54:13.432Z", "anonymous_donation": false, "gift_aid": false, "comment": "thanks", "donating_company": null, "currency": "USD", "converted_currency": "USD", "utm_campaign": "google_ads", "utm_source": "Adwords", "utm_medium": "cpc", "utm_term": "nonprofit fundraising", "utm_content": "np1", "processing_fee": 0.59, "formatted_processing_fee": "$0.59", "questions": [ { "question_type": "radiobutton", "question": "Would you like to volunteer?", "answer": "Yes" }, { "question_type": "text", "question": "Why are you donating", "answer": "I would like to help" }, { "question_type": "check", "question": "First/Last Name is correct?", "answer": true }, { "question_type": "dropdown", "question": "Would you like to showcase your donation", "answer": "Yes" } ] } ] ``` ``` -------------------------------- ### GET /api/v1/campaigns Source: https://github.com/donorbox/donorbox-api/blob/master/README.md Retrieves a list of all campaigns associated with the authenticated Donorbox account. ```APIDOC ## GET /api/v1/campaigns ### Description Retrieves a list of all campaigns associated with the authenticated Donorbox account. ### Method GET ### Endpoint /api/v1/campaigns ### Parameters None ### Request Example curl -X GET --user login@email.com:YOUR_API_KEY https://donorbox.org/api/v1/campaigns ### Response #### Success Response (200) - **id** (integer) - Unique identifier for the campaign - **name** (string) - Name of the campaign - **slug** (string) - URL slug for the campaign - **currency** (string) - Currency code - **goal_amt** (string) - Goal amount - **total_raised** (string) - Total amount raised - **donations_count** (integer) - Number of donations received #### Response Example [ { "id": 1, "name": "Donorbox New Campaign", "slug": "donorbox-new-campaign", "currency": "usd", "created_at": "2017-10-20T22:30:55.620Z", "updated_at": "2017-10-20T22:30:55.620Z", "goal_amt": "10000.0", "formatted_goal_amount": "$1,0000", "total_raised": "2000.0", "formatted_total_raised": "$2000", "donations_count": 66 } ] ``` -------------------------------- ### GET /api/v1/donors Source: https://github.com/donorbox/donorbox-api/wiki/Endpoints Retrieves a list of all donors associated with the organization. ```APIDOC ## GET /api/v1/donors ### Description Fetch comprehensive profiles for all donors who have contributed to the organization. ### Method GET ### Endpoint https://donorbox.org/api/v1/donors ### Response #### Success Response (200) - **donors** (array) - List of donor objects including contact info and donation statistics. #### Response Example [ { "id": 35, "first_name": "John", "last_name": "Doe", "email": "johndoe@email.com", "donations_count": 2 } ] ``` -------------------------------- ### GET /api/v1/donors Source: https://github.com/donorbox/donorbox-api/blob/master/README.md Retrieves a list of all donors registered in the account. ```APIDOC ## GET /api/v1/donors ### Description Returns a list of all donors with their contact details, donation history, and total contributions. ### Method GET ### Endpoint /api/v1/donors ### Response #### Success Response (200) - **donors** (array) - List of donor objects. #### Response Example [ { "id": 35, "first_name": "John", "last_name": "Doe", "email": "johndoe@email.com", "donations_count": 2 } ] ``` -------------------------------- ### GET /api/v1/plans Source: https://context7.com/donorbox/donorbox-api/llms.txt Retrieve all recurring donation plans. Supports filtering by donor email, date range, campaign ID, or donor ID. ```APIDOC ## GET /api/v1/plans ### Description Retrieve all recurring donation plans including schedule type, amount, payment method, and next donation date. Supports filtering by donor email, date range, campaign ID, or donor ID. ### Method GET ### Endpoint /api/v1/plans ### Query Parameters - **email** (string) - Optional - Filter plans by donor's email address. - **date_from** (string) - Optional - Filter plans started on or after this date (YYYY-MM-DD). - **date_to** (string) - Optional - Filter plans started on or before this date (YYYY-MM-DD). - **campaign_id** (integer) - Optional - Filter plans associated with a specific campaign ID. - **donor_id** (integer) - Optional - Filter plans associated with a specific donor ID. ### Request Example ```bash curl -X GET \ --user "admin@nonprofit.org:dk_live_abc123xyz" \ "https://donorbox.org/api/v1/plans" ``` ### Response #### Success Response (200) - **plans** (array) - A list of recurring donation plan objects. - **id** (integer) - The unique identifier for the plan. - **campaign** (object) - Information about the associated campaign. - **id** (integer) - The campaign ID. - **name** (string) - The campaign name. - **donor** (object) - Information about the donor. - **id** (integer) - The donor ID. - **name** (string) - The donor's full name. - **first_name** (string) - The donor's first name. - **last_name** (string) - The donor's last name. - **email** (string) - The donor's email. - **phone** (string) - The donor's phone number. - **address** (string) - The donor's street address. - **city** (string) - The donor's city. - **state** (string) - The donor's state. - **zip_code** (string) - The donor's zip code. - **country** (string) - The donor's country. - **employer** (string) - The donor's employer. - **occupation** (string) - The donor's occupation. - **type** (string) - The donation schedule type (e.g., "monthly"). - **amount** (string) - The donation amount. - **formatted_amount** (string) - The formatted donation amount (e.g., "$10"). - **payment_method** (string) - The payment method used (e.g., "Stripe"). - **started_at** (string) - The date the plan started (YYYY-MM-DD). - **last_donation_date** (string) - The date of the last donation (ISO 8601 format). - **next_donation_date** (string) - The date of the next scheduled donation (YYYY-MM-DD). - **status** (string) - The current status of the plan (e.g., "active"). #### Response Example ```json [ { "id": 168, "campaign": { "id": 61, "name": "Save the jungle campaign" }, "donor": { "id": 384, "name": "Bruce Wayne", "first_name": "Bruce", "last_name": "Wayne", "email": "bruce@email.com", "phone": "8038984624", "address": "123 6th St.", "city": "Melbourne", "state": "FL", "zip_code": "32904", "country": "USA", "employer": "Wayne Industries", "occupation": "CEO" }, "type": "monthly", "amount": "10.0", "formatted_amount": "$10", "payment_method": "Stripe", "started_at": "2018-07-25", "last_donation_date": "2018-07-25T05:00:00.000Z", "next_donation_date": "2018-08-25", "status": "active" } ] ``` ``` -------------------------------- ### Get All Campaigns - Donorbox API Source: https://github.com/donorbox/donorbox-api/wiki/Endpoints Retrieves a list of all campaigns associated with your Donorbox organization. Requires basic authentication with your organization email and API key. The output is a JSON array of campaign objects. ```http GET https://donorbox.org/api/v1/campaigns ``` ```json [ { "id":1, "name":"Donorbox New Campaign", "slug":"donorbox-new-campaign", "currency":"usd", "created_at":"2017-10-20T22:30:55.620Z", "updated_at":"2017-10-20T22:30:55.620Z", "goal_amt":"10000.0", "formatted_goal_amount":"$1,0000", "total_raised":"2000.0", "formatted_total_raised":"$2000", "donations_count":66 } ] ``` -------------------------------- ### GET /api/v1/purchases Source: https://context7.com/donorbox/donorbox-api/llms.txt Retrieve all event ticket purchases. Includes total amount, ticket count, and detailed ticket information. ```APIDOC ## GET /api/v1/purchases ### Description Retrieve all event ticket purchases including total amount, ticket count, and detailed ticket information. ### Method GET ### Endpoint /api/v1/purchases ### Parameters None ### Request Example ```bash curl -X GET \ --user "admin@nonprofit.org:dk_live_abc123xyz" \ "https://donorbox.org/api/v1/purchases" ``` ### Response #### Success Response (200) - **purchases** (array) - A list of purchase objects. - **id** (integer) - The unique identifier for the purchase. - **currency** (string) - The currency of the purchase amount (e.g., "USD"). - **status** (string) - The payment status of the purchase (e.g., "paid"). - **supporter_id** (integer) - The ID of the supporter who made the purchase. - **amount** (number) - The total amount of the purchase. - **amount_formatted** (string) - The formatted total purchase amount (e.g., "$0.82"). - **amount_refunded** (number) - The amount that has been refunded. - **date** (string) - ISO 8601 timestamp of the purchase. - **tickets_count** (integer) - The number of tickets included in the purchase. - **event** (object) - Information about the event associated with the purchase. - **id** (integer) - The event ID. - **name** (string) - The event name. - **tickets** (array) - A list of ticket objects included in the purchase. - **id** (integer) - The ticket ID. - **currency** (string) - The currency of the ticket price. - **free_ticket** (boolean) - Indicates if the ticket was free. - **price** (number) - The price of the ticket. - **price_formatted** (string) - The formatted price of the ticket. - **ticket_type** (object) - Details about the ticket type. - **id** (integer) - The ticket type ID. - **name** (string) - The name of the ticket type. - **fair_market_value** (number) - The fair market value of the ticket. - **tax_deductible_amount** (number) - The tax-deductible portion of the ticket price. #### Response Example ```json [ { "id": 231234, "currency": "USD", "status": "paid", "supporter_id": 986732, "amount": 0.82, "amount_formatted": "$0.82", "amount_refunded": 0.82, "date": "2023-10-04T16:50:33Z", "tickets_count": 1, "event": { "id": 123123, "name": "Concert for a Cure" }, "tickets": [ { "id": 675645, "currency": "USD", "free_ticket": false, "price": 1.04, "price_formatted": "$1.04", "ticket_type": { "id": 87678, "name": "General Admission", "fair_market_value": 0.4, "tax_deductible_amount": 0.6 } } ] } ] ``` ``` -------------------------------- ### Get All Plans - Donorbox API Source: https://github.com/donorbox/donorbox-api/blob/master/README.md Retrieves information for all donation plans associated with your Donorbox account. This endpoint returns a list of plan objects, each containing details like campaign information, donor specifics, donation type, amount, and status. ```http GET /api/v1/plans ``` ```json [ { "id": 168, "campaign": { "id": 61, "name": "Save the jungle campaign" }, "donor": { "id": 384, "name": "Bruce Waine", "first_name": "Bruce", "last_name": "Waine", "email": "bruce@email.com", "phone": "8038984624", "address": "123 6th St.", "city":"Melbourne", "state":"FL", "zip_code":"32904", "country": "USA", "employer": "Waine Industries", "occupation": "CEO" }, "type": "monthly", "amount": "10.0", "formatted_amount": "$10", "payment_method": "Stripe", "started_at": "2018-07-25", "last_donation_date": "2018-07-25T05:00:00.000Z", "next_donation_date": "2018-08-25", "status": "active" } ] ``` -------------------------------- ### GET /api/v1/donations Source: https://github.com/donorbox/donorbox-api/blob/master/README.md Retrieve donations with advanced filtering including amount ranges and donor information. ```APIDOC ## GET /api/v1/donations ### Description Retrieve donations filtered by donor, campaign, date, or specific amount ranges. ### Method GET ### Endpoint /api/v1/donations ### Parameters #### Query Parameters - **amount[usd][min]** (number) - Optional - Minimum donation amount - **amount[usd][max]** (number) - Optional - Maximum donation amount - **email** (string) - Optional - Filter by donor email - **campaign_id** (integer) - Optional - Filter by campaign ID ### Request Example GET /api/v1/donations?amount[usd][min]=10&amount[usd][max]=100 ### Response #### Success Response (200) - **donations** (array) - List of donation objects ``` -------------------------------- ### GET /api/v1/tickets Source: https://context7.com/donorbox/donorbox-api/llms.txt Retrieve all event tickets. Supports filtering by payment status. ```APIDOC ## GET /api/v1/tickets ### Description Retrieve all event tickets including pricing, ticket type details, fair market value, tax-deductible amounts, and transaction information. Supports filtering by payment status. ### Method GET ### Endpoint /api/v1/tickets ### Query Parameters - **payment_status** (string) - Optional - Filter tickets by their payment status (e.g., "refunded"). ### Request Example ```bash curl -X GET \ --user "admin@nonprofit.org:dk_live_abc123xyz" \ "https://donorbox.org/api/v1/tickets" ``` ### Response #### Success Response (200) - **tickets** (array) - A list of ticket objects. - **id** (integer) - The unique identifier for the ticket. - **currency** (string) - The currency of the ticket price (e.g., "USD"). - **free_ticket** (boolean) - Indicates if the ticket was free. - **price** (number) - The price of the ticket. - **price_formatted** (string) - The formatted price of the ticket (e.g., "$1.04"). - **ticket_type** (object) - Details about the type of ticket. - **id** (integer) - The ticket type ID. - **name** (string) - The name of the ticket type. - **fair_market_value** (number) - The fair market value of the ticket. - **fair_market_value_formatted** (string) - The formatted fair market value. - **tax_deductible_amount** (number) - The tax-deductible portion of the ticket price. - **tax_deductible_amount_formatted** (string) - The formatted tax-deductible amount. - **tax_amount** (number) - The tax amount included in the ticket price. - **tax_amount_formatted** (string) - The formatted tax amount. - **event** (object) - Information about the event the ticket belongs to. - **id** (integer) - The event ID. - **name** (string) - The event name. - **transaction** (object) - Information about the transaction for this ticket. - **id** (integer) - The transaction ID. - **first_name** (string) - The first name of the purchaser. - **last_name** (string) - The last name of the purchaser. - **email** (string) - The email address of the purchaser. - **status** (string) - The payment status of the transaction (e.g., "paid"). - **purchase_date** (string) - ISO 8601 timestamp of the purchase. - **stripe_charge_id** (string) - The Stripe charge ID, if applicable. #### Response Example ```json [ { "id": 123456, "currency": "USD", "free_ticket": false, "price": 1.04, "price_formatted": "$1.04", "ticket_type": { "id": 15132, "name": "General Admission", "fair_market_value": 0.4, "fair_market_value_formatted": "$0.40", "tax_deductible_amount": 0.6, "tax_deductible_amount_formatted": "$0.60", "tax_amount": 0.04, "tax_amount_formatted": "$0.04" }, "event": { "id": 123123, "name": "Concert for a Cure" }, "transaction": { "id": 212321, "first_name": "Jimmy", "last_name": "Wang", "email": "jw@example.org", "status": "paid", "purchase_date": "2023-10-04T16:50:33Z", "stripe_charge_id": "py_dhjfkxnh" } } ] ``` ``` -------------------------------- ### GET /api/v1/donations Source: https://context7.com/donorbox/donorbox-api/llms.txt Retrieve a list of all donations, including donor details, payment methods, and custom question responses. ```APIDOC ## GET /api/v1/donations ### Description Retrieve all donations including donor information, amount, payment method, and campaign details. ### Method GET ### Endpoint https://donorbox.org/api/v1/donations ### Parameters #### Query Parameters - **email** (string) - Optional - Filter by donor email - **date_from** (string) - Optional - Start date for filtering - **date_to** (string) - Optional - End date for filtering - **campaign_id** (integer) - Optional - Filter by campaign ID ### Response #### Success Response (200) - **id** (integer) - Donation ID - **amount** (string) - Donation amount - **donor** (object) - Donor information object #### Response Example [ { "id": 1, "amount": "100.0", "donor": { "name": "John Doe", "email": "johndoe@email.com" } } ] ``` -------------------------------- ### Retrieve Organization Donations Source: https://github.com/donorbox/donorbox-api/blob/master/README.md Fetches a list of all donations for an organization using the GET /api/v1/donations endpoint. The response format varies slightly depending on whether the donation was processed via Stripe or PayPal. ```json [ { "action": "new", "campaign": { "id": 1, "name": "Donorbox Campaign" }, "donor": { "id": 59, "name": "John Doe", "email": "johndoeemail@hotmail.com" }, "amount": "100.0", "stripe_charge_id": "ch_1BF94aBku99FiTp3uJM5mSKw", "donation_type": "stripe", "status": "paid" } ] ``` ```json [ { "campaign": { "id": 1, "name": "Donorbox Campaign" }, "donor": { "id": 59, "name": "John Doe", "email": "johndoeemail@hotmail.com" }, "amount": "100.0", "paypal_transaction_id": "RANDOMPAYPALID", "donation_type": "paypal", "status": "paid" } ] ``` -------------------------------- ### Get All Tickets - Donorbox API Source: https://github.com/donorbox/donorbox-api/blob/master/README.md Retrieves information about all ticket sales for your campaigns. This endpoint provides details on individual tickets, including their price, associated event, and transaction information. ```http GET /api/v1/tickets ``` ```json [ { "id": 123456, "currency": "USD", "free_ticket": false, "price": 1.04, "price_formatted": "$1.04", "ticket_type": { "id": 15132, "name": "General Admission", "fair_market_value": 0.4, "fair_market_value_formatted": "$0.40", "tax_deductible_amount": 0.6, "tax_deductible_amount_formatted": "$0.60", "tax_amount": 0.04, "tax_amount_formatted": "$0.04" }, "event": { "id": 123123, "name": "Concert for a Cure" }, "transaction": { "id": 212321, "city": "Alexandria", "state": "Viginia", "country": "US", "zip": "22304", "currency": "USD", "first_name": "Jimmy", "last_name": "Wang", "donation_id": null, "stripe_charge_id": "py_dhjfkxnh", "full_name": "Jimmy Wang", "address": "4801 Kenmore Ave", "phone": "8509608580", "email": "jw@example.org", "supporter_id": 9635959, "status": "paid", "purchase_date": "2023-10-04T16:50:33Z", "free_purchase": false, "price": 0.82, "price_formatted": "$0.82", "donation_amount": null, "donation_amount_formatted": null, "app_fee": 0.01, "app_fee_formatted": "$0.01", "stripe_fee": 0.33, "stripe_fee_formatted": "$0.33", "slug": "212321-hsdemhehe", "preferences_answer": null } } ] ``` -------------------------------- ### Get All Events - Donorbox API Source: https://github.com/donorbox/donorbox-api/blob/master/README.md Retrieves a list of all campaign events created in your Donorbox account. Each event object contains details such as its ID, name, creation date, total raised, and number of donations and tickets. ```http GET /api/v1/events ``` ```json [ { "id": 123123, "name": "Concert for a Cure", "slug": "concert-for-a-cure", "currency": "usd", "created_at": "2023-10-03T20:44:18Z", "updated_at": "2023-10-23T06:19:43Z", "total_raised": 0, "formatted_total_raised": "$0", "donations_count": 0, "tickets_count": 8 } ] ```