Skip to Main Content
REST
Getting Started
Checkout
Environment id
Blackbaud Merchant Services Account
Setup
Reference
General API Information
API Administrator Accounts for Server Access
Client and Server Differences
HTTP Status Codes
IP Allow List Security
Servlets
Using Redirect URLs
reCAPTCHA for donations
Authentication
Configuration
Configure API Keys
Configure API to Allow Server Access
Configure or View API Logs
Configure JavaScript Access
Configure AJAX Proxy Service
Advanced API Configuration
Cross Domain Access
JavaScript/AJAX
Error Response Codes
Address Book
Advocacy
Constituent
Content
DataSync
Donation
Event
Group
Single Sign-On
Survey
TeamRaiser
Parameters
Single Sign-On
Special Characters
Address Book
addAddressBookContact
addAddressBookContacts
addAddressBookGroup
addContactsToGroup
addressBookImportOAuthCallback
deleteAddressBookContacts
deleteAddressBookGroups
getAddressBookContacts
getAddressBookGroups
getAddressBookImportContacts
getAddressBookImportJobStatus
importAddressBookContacts
parseCsvContacts
removeContactFromGroup
startOnlineAddressBookImport
updateAddressBookContact
updateAddressBookGroup
Advocacy
getAdvocacyAlert
getAdvocacyAlerts
getAdvocacyInteractions
takeAction
Constituent
create
createOrUpdate
getGroupMembers
getInteraction
getUser
getUserCenters
getUserGroups
getUserInteractions
getUserInterests
getUserTransactions
isEmailValid
isUserInterested
isUserNameAvailable
listCenters
listInteractions
listInterests
listUserFieldChoices
listUserFields
logInteraction
logSocialShare
update
updateInteraction
Content
getMessageBundle
getTagInfo
listImages
listLinkProviders
listLinks
listSupportedLocales
DataSync
addXref
getDataSyncStatus
getOperations
launchDataSync
listComObjectsForXrefType
listForeignObjectsForXrefField
listXrefs
listXrefTypes
removeXref
Donation
Common Parameters
Billing
Designated Giving
Donation Level
Donor Details
eCard
Facebook
Gift Aid
Installment Giving
Joint Donor
Matching Gift
Premium
Sustaining Giving
TeamRaiser Donation
Tribute
Shadow Forms
addOfflineDonation
donate
donateACH
donateCheckout
getDesignationTypes
getDesignees
getDonationFormInfo
offlineOrganizationGift
offlineOrganizationGiftCheckout
recordRecurringTransaction
refundOfflineDonation
refundTransaction
startDonation
validateDonateCheckout
validateOfflineOrganizationGiftCheckout
Marketplace App Integration
Event
getChildEvents
getDayEvents
getEvent
getMonthEvents
Group
createGroup
deleteGroup
getGroupInfo
getGroupMembers
listGroups
Organization
addOrganization
addOrganizationAddress
addOrganizationContact
addOrganizationNote
addOrganizationPhoneNumber
addOrganizationRole
deleteAllOrganizationAddresses
deleteOrganization
deleteOrganizationAddress
deleteOrganizationContact
deleteOrganizationNote
deleteOrganizationParent
deleteOrganizationPhoneNumber
deleteOrganizationRole
getOrganization
getOrganizationAddressById
getOrganizationAddressByType
getOrganizationContact
getOrganizationDescendants
getOrganizationDetail
getOrganizationHierarchy
getOrganizationNote
getOrganizationParent
getOrganizationPhoneNumber
getOrganizationPhoneNumberById
getOrganizationRole
listOrganizationContacts
listOrganizationNotes
listOrganizationRoles
listOrganizations
listOrganizationTeamraisers
mergeOrganizations
setOrganizationParent
updateOrganization
updateOrganizationAddress
updateOrganizationContact
updateOrganizationDetail
updateOrganizationNote
updateOrganizationPhoneNumber
updateOrganizationRole
Recurring
calculateNextPaymentDate
cancelRecurringGift
getRecurringConfiguration
getRecurringGiftDetails
getRecurringGifts
getRecurringHistory
skipNextPayment
updateRecurringBankAccountInfo
updateRecurringCheckoutPaymentInfo
updateRecurringCreditCardInfo
updateRecurringGift
validateRecurringCheckoutPaymentInfo
Single Sign-On
authenticateUser
changePassword
getLoginUrl
getSingleSignOnToken
login
logInteraction
loginTest
logout
singleSignOn
Survey
getSurvey
listSurveys
submitSurvey
TeamRaiser
acknowledgeGifts
addDraft
addGift
addGiftCheckout
addLocalCompany
addNationalCompany
addRegionalCompany
addTeamraiserData
addTeamraiserEventManager
archiveNationalCompany
archiveRegionalCompany
confirmOrUnlinkFacebookFundraiser
createAndLinkFacebookFundraiser
createTeam
deleteDraft
deleteGift
deleteLocalCompany
deleteSentMessage
deleteTeamraiserAddressBookContacts
getCampaignByNameData
getCaptainsMessage
getCompaniesByInfo
getCompanyDonationByDay
getCompanyList
getCompanyPageInfo
getCompanyPagePreview
getCompanyPhoto
getCompanyShortcut
getCompanyTeams
getContactActivity
getDraft
getDrafts
getEventDataParameter
getEventGifts
getFlowStep
getFundraisingResults
getGift
getGiftCategories
getGifts
getLocalCompany
getMessageLayouts
getNationalCompany
getNewsFeeds
getOrganizationMessage
getParticipantCenterWrapper
getParticipantFBConnectInfo
getParticipantProgress
getParticipants
getParticipationType
getParticipationTypes
getPersonalDonationByDay
getPersonalMediaLayout
getPersonalPageInfo
getPersonalPagePreview
getPersonalPhotos
getPersonalVideoUrl
getPublicEventTypes
getRecentActivity
getRegionalCompany
getRegisteredTeamraisers
getRegistration
getRegistrationDocument
getSentMessage
getSentMessages
getShortcut
getSuggestedMessage
getSuggestedMessages
getSurveyResponses
getTeam
getTeamCaptains
getTeamDivisions
getTeamDonationByDay
getTeamGifts
getTeamMembers
getTeamPageInfo
getTeamPagePreview
getTeamPhoto
getTeamraiserAddressBookContact
getTeamraiserAddressBookContacts
getTeamraiserAddressBookContactsByIds
getTeamraiserAddressBookContactsGiftHistory
getTeamraiserAddressBookFilters
getTeamraiserAddressBookGroupContacts
getTeamraiserConfig
getTeamraiserEventManagerRoles
getTeamraiserResultsData
getTeamraisersByDistance
getTeamraisersByInfo
getTeamraiserSuggestion
getTeamRoster
getTeamsByInfo
getTeamShortcut
getTeamVideoUrl
getTentingSearch
getTentmate
getTopCompaniesData
getTopDonors
getTopParticipantsData
getTopTeamDonors
getTopTeamsData
getUpsell
joinTeam
leaveTeam
listTeamraiserEventManagers
previewMessage
processRegistration Classic Checkout
processRegistration New Checkout
processRegistrationPaypal
removeCompanyPhoto
removePersonalPhoto
removeTeamPhoto
removeTeamraiserEventManager
sendTafMessage
setTeamCaptains
updateCaptainsMessage
updateCompanyPageInfo
updateCompanyShortcut
updateDraft
updateLocalCompany
updateNationalCompany
updatePersonalMediaLayout
updatePersonalPageInfo
updatePersonalPagePrivacy
updatePersonalVideoUrl
updateRegionalCompany
updateRegistration
updateShortcut
updateSurveyResponses
updateTeamInformation
updateTeamPageInfo
updateTeamraiserAddressBookContact
updateTeamraiserData
updateTeamShortcut
updateTeamVideoUrl
updateTentingStatus
uploadCompanyPhoto
uploadPersonalPhoto
uploadTeamPhoto
validateAddGiftCheckout
validateDiscount
validateProcessRegistration New Checkout
XML Schema Definition
Common
Addressbook
Advocacy
Constituents
Content
DataSync
Donation
Event
Group
Organization
Recurring
Survey
TeamRaiser
Home
REST
Getting Started
Reference
Reference
General API Information
Learn more about servlets and HTTP status codes.
Authentication Tokens
Find out about token-based authentication and how to easily implement in your applications.
Configuration
Configure access for externally hosted applications and domains to be proxied through the LO server.
Cross Domain Access
Allow hosting from other sites.
Error Codes
View a list of API error codes.
Parameters
View common parameters supported by all Luminate Online® APIs.
reCAPTCHA v3
Protect API-based donations.
Single Sign-On
Configure Single Sign-On for APIs.