Error
A valid request URL is required to generate request examples{
"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": "NOT_FOUND"
}{
"error": "<string>",
"code": "<string>"
}API Reference
Get a charity by id
Get a single charity by id (full metadata).
GET
/
charities
/
{charityId}
Error
A valid request URL is required to generate request examples{
"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": "NOT_FOUND"
}{
"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:
1Path Parameters
Charity id
Response
Charity with full metadata.
Available options:
US, UK, CA, DE, ES, FR, IE, IT, NL, PT, AR, BR, CL, CO, PE, LEGACY Available options:
ACTIVE_ONBOARDED, ACTIVE_NOT_ONBOARDED, SOFT_HIDDEN, PLATFORM_DISABLED, OPTED_OUT Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?