• Overview

    This is a Professional Plan only feature - to upgrade see https://donorfy.com/pricing   The Donorfy API allows web sites, other systems and so on to retrieve and send data to Donorfy. This is an advanced feature - you will need programming skills...

    Ben Brett
  • Interactive documentation

    To go to the interactive documentation for all the API's endpoints please go to https://data.donorfy.com/help/index

    Robin Fisk
  • Constituents

    This article provides information about working with Constituents via the API Finding constituents You can retrieve details of constituents using Constituent Id - e.g. https://data.donorfy.com/api/v1/<your api key>/53530b0c-5eed-4fad-b400-347afc0...

    Ben Brett
  • 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...

    Ben Brett
  • Constituent Purpose & Channel Preferences

    This article provides information about working with Purpose and Channel Preferences via the API. The https://data.donorfy.com/api/v1/<apikey>/Constituents/<constituentId>/Preferences endpoint allows to you retrieve or update channel and purposes ...

    Ben Brett
  • Constituent Tags

    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...

    Ben Brett
  • Connections

    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 https://data.donorfy.com/api/v1/<apikey>/constituents/{constituentid}/Conne...

    Ben Brett
  • Activities

    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 ...

    Ben Brett
  • 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...

    Ben Brett
  • 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 ...

    Ben Brett
  • Transactions

    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...

    Ben Brett
  • 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 the Campaigns from the main menu The https://data.donorfy.com/api/v1/<apikey>/System/LookUpType...

    Ben Brett
  • Lists

    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 ...

    Ben Brett
  • Webhooks

    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...

    Ben Brett
  • 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,...

    Robin Fisk