The API is a tool that enables developers to build custom integrations between Donorfy and other apps. This feature is available as part of the Professional Plan - see our plan comparison guide and pricing guide here: https://donorfy.com/pricing
The Donorfy API allows websites, other systems and so on to retrieve and send data to Donorfy. This is an advanced feature - you will need programming skills or help from a Donorfy partner to make use of this feature. Requirements The Donorfy AP...
To go to the interactive documentation for all the API's endpoints please go to https://data.donorfy.com/help/index The Donorfy API is a Professional-only feature. Essential subscribers, please contact us to find out more about upgrading.
This article provides information about working with Constituents via the API Finding constituents You can retrieve details of constituents using: Constituent ID https://data.donorfy.com/api/v1/<your api key>/53530b0c-5eed-4fad-b400-347afc0a389a ...
Finding Potential Duplicates
This article provides information about finding potential duplicate individual constituents via the API - for example, if you are writing an integration to Donorfy using the API you can use this functionality to locate existing individuals and avo...
Constituent Purpose & Channel Preferences
This article provides information about working with Purpose and Channel Preferences via the API. The Purpose and Channel Preferences endpoint allows to you retrieve or update Channels and Purposes for a constituent A get request to the endpoint b...
When you are adding a constituent or adding timeline items - e.g. transactions - you can add active or excluded tags to constituents by passing details using the ActiveTags & ExcludedTags properties - the ActiveTags contains details of tags you wa...
This article provides information about working with Connections via the API. You can work with Connections as follows: Connections can be added via a post request to the Connections endpoint - a new connection will be added to the constituent id...
This article provides information about working with Activities via the API. Note if you want to add activities that are linked to recurring payment instructions you should use the https://data.donorfy.com/api/v1/<apikey>/rpis/<rpiid>/AddActivity ...
Gift Aid Declarations
This article provides information about working with Gift Aid Declarations via the API. You can work with Gift Aid Declarations as follows Gift Aid Declarations can be added via a post request to the https://data.donorfy.com/api/v1/<apikey>/const...
Recurring Payment Instructions
Adding and Updating Recurring Payment Instructions Important when you add an RPI via the API Donorfy does not lodge any details with your payment processor or gateway - e.g. Stripe, GoCardless and so on - if you need to lodge details you must do ...
This article provides information about working with Transactions via the API Adding Transactions Important when you add a transaction via the API Donorfy does not collect the payment via your payment processor or gateway - e.g. Stripe, GoCardless...
Look Ups and Campaigns
This article provides information about working with LookUps and Campaigns via the API - i.e. the lists you can maintain via Settings > Configuration and the Campaigns within Donorfy To return a list of the available lookup types, use the endp...
This article provides information about using Lists via the API. Lists are built using the Donorfy UI and return a list of items that match any filter applied to the list. The API allows you to retrieve The lists that exist in your Donorfy - for ...
Retrieving List Results Asynchronously
If your list returns a large number of rows you can generate a snapshot of the results and retrieve the data from the snapshot - this has the benefit over the simpler list results retrieval method as the results are guaranteed not to change as the...
Webhooks are a mechanism that allows Donorfy to notify another 'receiving' system when data has been added, changed or deleted. This is an advanced feature - you may need programming skills or the help from a Donorfy partner to make use of this fe...
Troubleshooting the API
Troubleshooting Has the API been enabled on your Donorfy? If not, create a support request to ask for it to be enabled. The API will work when it is enabled and the correct instructions are sent to it. To make test calls you will need to download,...