View Source Authentication

CharityAPI.org expects all API requests to be authenticated by passing your API key in the http 'apikey' header.

Example:

curl 

curl "https://api.charityapi.org/api/organizations/search/food" \
  -H "apikey: keyhere"
HTTP HeaderValue
apikeyYour API Key

When you register you will receive 2 API Keys; one live (prefixed with live-) and one test (prefixed with test-). Calls with the test key will return validly-shaped but bogus data; you can use it in development but we don't recommend using it for your test suite or CI. For your test suite, please mock or stub out the responses from this API.

API Key Examples:

Key TypeExample Value
Livelive-PKDv6IZSgxXEJzGnQLIdDsObIpr1PpA5NQd0VbKh2JZaaTkxsH1X5eRcbsyEiOVhPWOOYVoD3zTrXVyO
Testtest-aaRkxsH1X5eRcbsyEiOVhPWOOYVoD3zTrXVyOPKDv6IZSgxXEJzGnQLIdDsObIpr0PpA5NQz0VbQh2JZ