Error
A valid request URL is required to generate request examples{
"pageKey": "<string>",
"response": [
{
"id": "<string>",
"slug": "<string>",
"name": "<string>",
"logo": "<string>",
"website": "<string>",
"mission": "<string>",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"country": "US",
"zipCode": "<string>",
"taxId": "<string>",
"status": "ACTIVE_ONBOARDED",
"configId": "<string>",
"socials": {
"blog": "<string>",
"twitter": "<string>",
"facebook": "<string>",
"instagram": "<string>",
"linkedin": "<string>",
"youtube": "<string>",
"blogUrl": "<string>",
"twitterUrl": "<string>",
"twitterHandle": "<string>",
"facebookUrl": "<string>",
"facebookHandle": "<string>",
"instagramUrl": "<string>",
"instagramHandle": "<string>",
"linkedinUrl": "<string>",
"linkedinHandle": "<string>",
"youtubeUrl": "<string>",
"youtubeHandle": "<string>",
"youtubeChannelId": "<string>"
},
"isEnabled": true,
"stats": {
"pendingUsdE6": "<string>",
"finalizedUsdE6": "<string>",
"displayedUsdE6": "<string>",
"pendingCount": 123,
"finalizedCount": 123,
"donationCount": 123,
"firstDonationAt": "<string>",
"lastDonationAt": "<string>"
}
}
]
}{
"error": "<string>",
"code": "<string>"
}API Reference
List charities
List Charity records with full metadata and optional participation filtering.
GET
/
charities
Error
A valid request URL is required to generate request examples{
"pageKey": "<string>",
"response": [
{
"id": "<string>",
"slug": "<string>",
"name": "<string>",
"logo": "<string>",
"website": "<string>",
"mission": "<string>",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"country": "US",
"zipCode": "<string>",
"taxId": "<string>",
"status": "ACTIVE_ONBOARDED",
"configId": "<string>",
"socials": {
"blog": "<string>",
"twitter": "<string>",
"facebook": "<string>",
"instagram": "<string>",
"linkedin": "<string>",
"youtube": "<string>",
"blogUrl": "<string>",
"twitterUrl": "<string>",
"twitterHandle": "<string>",
"facebookUrl": "<string>",
"facebookHandle": "<string>",
"instagramUrl": "<string>",
"instagramHandle": "<string>",
"linkedinUrl": "<string>",
"linkedinHandle": "<string>",
"youtubeUrl": "<string>",
"youtubeHandle": "<string>",
"youtubeChannelId": "<string>"
},
"isEnabled": true,
"stats": {
"pendingUsdE6": "<string>",
"finalizedUsdE6": "<string>",
"displayedUsdE6": "<string>",
"pendingCount": 123,
"finalizedCount": 123,
"donationCount": 123,
"firstDonationAt": "<string>",
"lastDonationAt": "<string>"
}
}
]
}{
"error": "<string>",
"code": "<string>"
}Authorizations
Developer API key. Required for config create/list/delete and project analytics. Optional on public GET reads (anonymous callers are IP rate-limited). Obtain from the Developer dashboard.
Headers
Optional. Omit for the anonymous IP budget (~20 req/min). Keys share their organization billing-tier limit.
Minimum string length:
1Query Parameters
Page size (min 1, max 200)
Required range:
1 <= x <= 200Cursor for next page (from previous pageKey)
Filter by enabled state. Omit to return all charities unless publicOnly is set.
Available options:
true, false Search term
Maximum string length:
200Available options:
relevance, alphabetical, topDonations, recentDonations, recentlyAdded Available options:
true, false Available options:
true, false Available options:
true, false Was this page helpful?