Fundraisers
Our fundraiser API endpoints enable you to query information about existing nonprofit fundraisers and create new ones.
Current version: v0.2
GET /v0.2/nonprofit/:nonprofitIdentifier/fundraiser/:fundraiserIdentifier
Enables retrieving details about an existing nonprofit fundraiser.
Authentication: public key
Usage
JavaScript fetch
fetch(
"https://partners.every.org/v0.2/nonprofit/wphfund/fundraiser/wphf-giving-tuesday?apiKey=myPublicApiKey"
);
curl
curl "https://partners.every.org/v0.2/nonprofit/wphfund/fundraiser/wphf-giving-tuesday?apiKey=myPublicApiKey"
GET /v0.2/nonprofit/:nonprofitIdentifier/fundraiser/:fundraiserIdentifier/raised
Returns details about how much an existing nonprofit fundraiser has raised.
Authentication: public key
Response format
The response will be a JSON-formatted object with the following properties:
currency
: "USD"raised
: Amount raised in centssupporters
: The number of people who have made a donation to this fundraisergoalAmount
: The current goal for the fundraiser in centsgoalType
: "CUSTOM" - the fundraiser creator manually set the goal, or "AUTOMATIC" - An Every.org-determined goal based on the current amount raised
Usage
JavaScript fetch
fetch(
"https://partners.every.org/v0.2/nonprofit/wphfund/fundraiser/wphf-giving-tuesday/raised?apiKey=myPublicApiKey"
);
curl
curl "https://partners.every.org/v0.2/nonprofit/wphfund/fundraiser/wphf-giving-tuesday/raised?apiKey=myPublicApiKey"
POST /v0.2/fundraiser
Enables creating new fundraisers. The fundraiser creator will be the username associated with the keys used to authenticate the request.
Authentication: private key
Request body
The POST
request body should be a JSON-formatted object with the following
properties:
nonprofitId
: The UUID of the nonprofit being supported by the fundraiser.title
: Fundraiser titledescription
: Description of the fundraiser ornull
,startDate
: An ISO-encoded datetime string for when the fundraiser starts ornull
,endDate
: An ISO-encoded datetime string for when the fundraiser ends ornull
,goal
: An integer for the goal of the fundraiser in cents ornull
,- raisedOffline: An integer for how much has been raised offline for this
fundraiser or
null
, currency
: Currently only supports "USD",
Usage
JavaScript
fetch(`https://partners.every.org/v0.2/fundraiser`, {
method: HttpMethod.POST,
headers: {
"Content-Type": "application/json",
/* eslint-enable @typescript-eslint/naming-convention */
Authorization: `Basic ${Buffer.from(`${publicKey}:${privateKey}`).toString(
"base64"
)}`,
},
body: {
nonprofitId: "c1c38cb5-16d6-4aca-a949-83c8e7cc1b88",
title: "Direct Cash Transfers Rule!",
description: "I'm raising $1,000 this March to support GiveDirectly's use of direct cash transfers to help people in need.",
startDate: new Date("2023-03-01").toISOString(),
endDate: new Date("2023-04-01").toISOString(),
goal: 100000,
raisedOffline: null,
currency: "USD",
},