Overview

There are 2 API endpoints campaign_info.php and donations.php: campaign_info.php returns information about the campaign, and donations.php returns a list of donors. The base url for all API queries is https://abcharity.org/extras/api. All API request must include an API key in the id GET parameter. Each campaign has a unique API key regardless of how many campaigns are under one account.

The API key for the the campaign you're viewing now is

 bHl3WW1Bc3loam5CemVYRd5lKqVNxKVqGFy%2F2ThDWL4%2BW99SVhkiHt6t8xGbaGes0GBfrISmQ5qnnhF2V7B%2Fjg%3D%3D

An example minimum API request would be

https://abcharity.org/extras/api{endpoint}?id=bHl3WW1Bc3loam5CemVYRd5lKqVNxKVqGFy%2F2ThDWL4%2BW99SVhkiHt6t8xGbaGes0GBfrISmQ5qnnhF2V7B%2Fjg%3D%3D

---

Donations Endpoint: View & search for donations

Endpoint: /donations.php

---

Request Parameters (GET)

• id (required): Encrypted campaign ID. Use your API key as the id parameter. Example: /donations?id={API_KEY}

• offline (optional): Filter based on whether the donation is offline.

  • 1: Only offline donations.
  • 0: Only online donations.

• min (optional): Minimum donation amount. Example: min=5.

• max (optional): Maximum donation amount. Example: max=100

• from_time (optional): Only show donations after that time. Accepts either an epoch timestamp or a date. Example: from_time=1727831492 or from_time=2024-10-01.

• to_time (optional): Only show donations before that time. Accepts either an epoch timestamp or a date. Example: to_time=1727831492 or to_time=2024-10-01.

• search (optional): Search for a string in specific columns (see search_cols). Example: search=john@example.com.

• search_cols (optional): Comma-separated list of columns to search in. Allowed columns: name, email, phone, notes. Defaults to all. Example: search_cols=name,email.

• strict_search (optional): Enable strict search for exact matches. Use 1 for strict mode, otherwise partial matches are used by default.

• order_by (optional): Column to order results by. Allowed values: id, amount, name, email. Default: id.

• order (optional): Sorting order. Either ASC (ascending) or DESC (descending). Default: DESC.

• limit (optional): Limit the number of results returned. Default: 100,000.

---

Responses

• 200 OK: Returns a JSON object containing donation data.

  • num_results: Number of donations matching the criteria.
  • donations: Array of donation objects:
    • id: Donation ID.
    • campaign_id: Campaign ID.
    • amount: Donation amount (in the campaign's currency).
    • net: Net amount after fees (in the campaign's currency).
    • name: Donor's name.
    • email: Donor's email.
    • phone: Donor's phone.
    • donation_time: The epoch timestamp of the donation.
    • notes: Notes related to the donation.
    • anonymous_donation: Whether the donation is anonymous.
    • address: Donor's address.
    • is_subscription: Whether the donation is a subscription.
    • team: Team name associated with the donation (if any).

• 401 Unauthorized: Invalid or missing campaign ID.

  • JSON Object: a JSON object with the error (see Error Handling)

• 406 Not Acceptable: Invalid search or sorting parameters.

  • JSON Object: a JSON object with the error (see Error Handling)

• 500 Internal Server Error: Server encountered an issue processing the request.

  • JSON Object: a JSON object with the error (see Error Handling)

---

Example Request

 https://abcharity.org/extras/api/donations.php?id=bHl3WW1Bc3loam5CemVYRd5lKqVNxKVqGFy%2F2ThDWL4%2BW99SVhkiHt6t8xGbaGes0GBfrISmQ5qnnhF2V7B%2Fjg%3D%3D&min=180&order=DESC&order_by=amount

---

Error Handling

• Returns a JSON object containing information about the error.

  • code: The HTTP status code.
  • error: Always 1 indicating an error occurd.
  • reason: A short description fo the error.
  • suggestion: Suggestions on how to fix the request.