To access GivingData’s Open APIs, you’ll need an API Key. Each user in GivingData can be assigned an API Key. This API Key must be passed in a X-API-Key HTTP header for each API call.
To create an API Key for your user, visit “Manage My Profile > Integrations” and click “Create API Key”. You can optionally assign an expiration date for your API Key if you want it to only be operable for a certain amount of time.
NOTE: The available APIs that your API keys will apply to are defined based on your role permissions and the features turned on on the back end. Please reach out to your CSM should you need access to a certain API, and see the “Permissions” tab for more information about the necessary permissions for your role to generate an API.
Once you create your API Key, you can click on the copy button to copy it to your clipboard. From this same page, you can delete your API Key or generate a new one.
If you delete your API Key, or generate a new one, any existing integrations using the old value will no longer work. You’ll have to update those integrations with your new API Key.
API Keys can also be created and managed for other GivingData users in the “Settings > Users” area. The same options to generate, delete, and set an expiration date are available here for all users who have “Manage Users and Roles” Permissions within their Role.
Once you have an API Key you are ready to make an API call. The API Key associated with your user account must be passed in a “X-Api-Key” HTTP header with every request you make. For example:
curl --request GET \
--url https://{your GivingData subdomain}/api/public/published/attribtypes \
--header 'Accept: application/json' \
--header 'X-Api-Key: {your API Key}'