The API does not prevent duplicate lookup values. Always check existing entries before creating new ones.
Retrieve Available Lookup Types
Lookup types define which configuration lists you can manage via the API.
Send a GET request to retrieve all available lookup types
Review the returned list to identify the lookup types you need.
Use this endpoint:
These lookup types broadly match a subset of items found under Settings, then Configuration, and include Campaigns.
Retrieve Lookups for a Specific Type
Once you know the lookup type, you can retrieve its current values.
Identify the lookup type name from the available lookup types.
Send a GET request for that lookup type.
Example:
Retrieve all constituent types using the ConstituentTypes lookup type: https://data.donorfy.com/api/v1/<apikey>/System/LookUpTypes/ConstituentTypes
The response contains all existing lookup entries for that type.
Add a New Lookup Entry
You can add new values to supported lookup lists.
Choose the correct lookup type.
Send a POST request with the lookup description:
https://data.donorfy.com/api/v1/<apikey>/System/LookUpTypes/<lookuptype> -
📌Note: The API does not validate uniqueness. Duplicate entries can be created if you do not check first.
Retrieve Campaigns
Campaigns are treated as a lookup type.
Send a GET request to retrieve all campaigns:
https://data.donorfy.com/api/v1/<apikey>/System/LookUpTypes/CampaignsUse the returned IDs and descriptions for further processing.
Campaigns returned by the API correspond to campaigns configured in Donorfy.
Work with Tag Categories
Tags are organised into categories, which must exist before tags can be added.
Retrieve Tag Categories
Send a GET request to retrieve all tag categories: https://data.donorfy.com/api/v1/<apikey>/System/LookUpTypes/<tagCategoryName>/Tags
Review the category names for use in subsequent calls.
Tag category names are used directly in the endpoint URL.
Retrieve Tags Within a Category
You can list all tags within a specific category.
Identify the tag category name:
Send a GET request for that category’s tags: https://data.donorfy.com/api/v1/<apikey>/System/LookUpTypes/TagCategory
Only tags belonging to the specified category are returned.
Add a New Tag to a Category
You can add new tags to an existing category.
Choose the tag category.
Send a POST request with the tag name as the lookup description:
https://data.donorfy.com/api/v1/<apikey>/System/LookUpTypes/Engagement/Tags passing Membership as the lookup description -
Confirm the tag appears in the category.
As with other lookups, the API does not check for duplicates.
⚠️Important:
The Donorfy API is a Professional only feature. Essential subscribers, please contact us to find out more about upgrading.