Bloomerang

App · 25 actions

Manage constituents and notes, and read fundraising campaigns, funds, gifts and interactions.

Actions

ActionWhat it does
Create constituentCreate constituent.
Create noteCreate note.
Delete constituentDelete constituent.
Delete noteDelete note.
Get appealGet appeal.
Get campaignGet campaign.
Get constituentGet constituent.
Get current userGet current user.
Get fundGet fund.
Get householdGet household.
Get interactionGet interaction.
Get noteGet note.
Get organizationGet organization.
Get transactionGet transaction.
List appealsList appeals.
List campaignsList campaigns.
List constituentsList constituents.
List fundsList funds.
List householdsList households.
List interactionsList interactions.
List notesList notes.
List transactionsList transactions.
Search constituentsSearch constituents.
Update constituentUpdate constituent.
Update noteUpdate note.

Create constituent

Create constituent.

Inputs

TypetypetextRequired
Type.One of: Individual, Organization.
Statusstatustext
Status.One of: Active, Inactive, Deceased.
First namefirst_nametext
FirstName.
Last namelast_nametext
LastName.
Middle namemiddle_nametext
MiddleName.
Prefixprefixtext
Must match a prefix in the Bloomerang CRM
Suffixsuffixtext
Must match a suffix in the Bloomerang CRM
Full namefull_nametext
FullName.
Informal nameinformal_nametext
InformalName.
Formal nameformal_nametext
FormalName.
Envelope nameenvelope_nametext
EnvelopeName.
Recognition namerecognition_nametext
RecognitionName.
Job titlejob_titletext
JobTitle.
Employeremployertext
Employer.
Websitewebsitetext
Website.
Facebook IDfacebook_idtext
FacebookId.
Twitter IDtwitter_idtext
TwitterId.
Linked in IDlinked_in_idtext
LinkedInId.
Gendergendertext
Gender.One of: Male, Female, Other.
Birthdatebirthdatedate
Birthdate.
Profile picture typeprofile_picture_typetext
ProfilePictureType.One of: None, Custom, Twitter.
Primary addressprimary_addressobject
Additional structured primary address. Use the documented fields.
Secondary addressessecondary_addresseslist
Non-primary addresses
Primary emailprimary_emailobject
Additional structured primary email. Use the documented fields.
Secondary emailssecondary_emailslist
Non-primary email addresses
Primary phoneprimary_phoneobject
Additional structured primary phone. Use the documented fields.
Secondary phonessecondary_phoneslist
Non-primary phones
Full custom profile imagefull_custom_profile_imagetext
The full picture File Attachment. Note that a Constituent can only have one Profile Picture; adding a new one will remove the old one.
Cropped custom profile imagecropped_custom_profile_imagetext
The cropped picture File Attachment. Note that a Constituent can only have one Profile Picture; adding a new one will remove the old one.
Custom valuescustom_valueslist
CustomValues.
Household IDhousehold_idnumber
The ID of the household this constituent is in (not to be confused with AccountNumber)
Preferred communication channelpreferred_communication_channeltext
PreferredCommunicationChannel.One of: Email, Phone, TextMessage, Mail.
Communication restrictionscommunication_restrictionslist
CommunicationRestrictions.One or more of: DoNotCall, DoNotMail, DoNotSolicit.
Email interest typeemail_interest_typetext
EmailInterestType.One of: All, Custom, OptedOut.
Custom email interest IDscustom_email_interest_idslist
IDs for custom email interests if the email interest type is Custom

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "AccountNumber": 1,
    "AddressIds": [],
    "AuditTrail": {
      "CreatedDate": "example",
      "CreatedName": "example",
      "LastModifiedDate": "example",
      "LastModifiedName": "example"
    },
    "Birthdate": "example",
    "CommunicationRestrictions": [],
    "CommunicationRestrictionsUpdateReason": "example",
    "CroppedCustomProfileImageId": 1,
    "CroppedCustomProfileImageUrl": "example",
    "CustomEmailInterests": [],
    "CustomValues": [],
    "DonorSearchInfo": {
      "AnnualFundLikelihood": "Low",
      "BusinessExecutive": true,
      "BusinessRevenues": 1,
      "DateTimeScreenedUtc": "example",
      "DemocraticContributionCount": 1,
      "Foundations": "example",
      "GenerosityScore": "Low",
      "GenerosityScoreLabel": "example",
      "Id": 1,
      "IndependentContributionCount": 1,
      "LargestGiftMax": 1,
      "LargestGiftMin": 1,
      "LargestGiftOrg": "example",
      "MajorGiftLikelihood": "Low",
      "NamesScreened": "example",
      "Quality": "Low",
      "RealEstateCount": 1,
      "RepublicanContributionCount": 1,
      "TotalGiftAmount": 1,
      "WealthAskMax": 1,
      "WealthAskMin": 1
    },
    "EmailIds": [],
    "EmailInterestType": "All",
    "EmailInterestsUpdateReason": "example",
    "Employer": "example",
    "EngagementScore": "Low",
    "EngagementScoreLabel": "example",
    "EnvelopeName": "example",
    "FacebookId": "example",
    "FirstName": "example",
    "FormalName": "example",
    "FullCustomProfileImageId": 1,
    "FullCustomProfileImageUrl": "example",
    "FullName": "example",
    "Gender": "Male",
    "HouseholdId": 1,
    "Id": 1,
    "InformalName": "example",
    "IsFavorite": true,
    "IsHeadOfHousehold": true,
    "IsInHousehold": true,
    "JobTitle": "example",
    "LastName": "example",
    "LinkedInId": "example",
    "MiddleName": "example",
    "PhoneIds": [],
    "PreferredCommunicationChannel": "Email",
    "Prefix": "example",
    "PrimaryAddress": {
      "AccountId": 1,
      "AuditTrail": {
        "CreatedDate": "example",
        "CreatedName": "example",
        "LastModifiedDate": "example",
        "LastModifiedName": "example"
      },
      "City": "example",
      "Country": "example",
      "CountryCode": "example",
      "Id": 1,
      "IsBad": true,
      "IsPrimary": true,
      "PostalCode": "example",
      "State": "example",
      "StateAbbreviation": "example",
      "Street": "example",
      "Type": "Home"
    },
    "PrimaryEmail": {
      "AccountId": 1,
      "AuditTrail": {
        "CreatedDate": "example",
        "CreatedName": "example",
        "LastModifiedDate": "example",
        "LastModifiedName": "example"
      },
      "Id": 1,
      "IsBad": true,
      "IsPrimary": true,
      "Type": "Home",
      "Value": "example"
    },
    "PrimaryPhone": {
      "AccountId": 1,
      "AuditTrail": {
        "CreatedDate": "example",
        "CreatedName": "example",
        "LastModifiedDate": "example",
        "LastModifiedName": "example"
      },
      "Extension": "example",
      "Id": 1,
      "IsPrimary": true,
      "Number": "example",
      "Type": "Home"
    },
    "ProfilePictureType": "None",
    "RecognitionName": "example",
    "Status": "Active",
    "Suffix": "example",
    "TwitterId": "example",
    "Type": "Individual",
    "Website": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Create note

Create note.

Inputs

Account IDaccount_idnumberRequired
The ID of the constituent used in the API (not to be confused with accountNumber)
DatedatedateRequired
Date.
NotenotetextRequired
Note.
Custom valuescustom_valueslist
CustomValues.
Attachmentsattachmentslist
Attachments.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "AccountId": 1,
    "AttachmentIds": [],
    "AuditTrail": {
      "CreatedDate": "example",
      "CreatedName": "example",
      "LastModifiedDate": "example",
      "LastModifiedName": "example"
    },
    "CustomValues": [],
    "Date": "example",
    "Id": 1,
    "Note": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Delete constituent

Delete constituent.

Inputs

IdidnumberRequired
The ID of the constituent to return.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "Deleted": true,
    "Id": 1,
    "Type": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Delete note

Delete note.

Inputs

IdidnumberRequired
The ID of the note to return.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "Deleted": true,
    "Id": 1,
    "Type": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Get appeal

Get appeal. Returns the full service response for the connected account.

Inputs

IdidnumberRequired
The ID of the appeal to return.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "AuditTrail": {
      "CreatedDate": "example",
      "CreatedName": "example",
      "LastModifiedDate": "example",
      "LastModifiedName": "example"
    },
    "Id": 1,
    "IsActive": true,
    "Name": "example",
    "SortIndex": 1
  },
  "has_more": false,
  "next_cursor": null
}

Get campaign

Get campaign. Returns the full service response for the connected account.

Inputs

IdidnumberRequired
The ID of the campaign to return.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "AuditTrail": {
      "CreatedDate": "example",
      "CreatedName": "example",
      "LastModifiedDate": "example",
      "LastModifiedName": "example"
    },
    "EndDate": "example",
    "Goal": 1,
    "Id": 1,
    "IsActive": true,
    "Name": "example",
    "Raised": 1,
    "RaisedCalculationMode": "Legacy",
    "SortIndex": 1,
    "StartDate": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Get constituent

Get constituent. Returns the full service response for the connected account.

Inputs

IdidnumberRequired
The ID of the constituent to return.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "AccountNumber": 1,
    "AddressIds": [],
    "AuditTrail": {
      "CreatedDate": "example",
      "CreatedName": "example",
      "LastModifiedDate": "example",
      "LastModifiedName": "example"
    },
    "Birthdate": "example",
    "CommunicationRestrictions": [],
    "CommunicationRestrictionsUpdateReason": "example",
    "CroppedCustomProfileImageId": 1,
    "CroppedCustomProfileImageUrl": "example",
    "CustomEmailInterests": [],
    "CustomValues": [],
    "DonorSearchInfo": {
      "AnnualFundLikelihood": "Low",
      "BusinessExecutive": true,
      "BusinessRevenues": 1,
      "DateTimeScreenedUtc": "example",
      "DemocraticContributionCount": 1,
      "Foundations": "example",
      "GenerosityScore": "Low",
      "GenerosityScoreLabel": "example",
      "Id": 1,
      "IndependentContributionCount": 1,
      "LargestGiftMax": 1,
      "LargestGiftMin": 1,
      "LargestGiftOrg": "example",
      "MajorGiftLikelihood": "Low",
      "NamesScreened": "example",
      "Quality": "Low",
      "RealEstateCount": 1,
      "RepublicanContributionCount": 1,
      "TotalGiftAmount": 1,
      "WealthAskMax": 1,
      "WealthAskMin": 1
    },
    "EmailIds": [],
    "EmailInterestType": "All",
    "EmailInterestsUpdateReason": "example",
    "Employer": "example",
    "EngagementScore": "Low",
    "EngagementScoreLabel": "example",
    "EnvelopeName": "example",
    "FacebookId": "example",
    "FirstName": "example",
    "FormalName": "example",
    "FullCustomProfileImageId": 1,
    "FullCustomProfileImageUrl": "example",
    "FullName": "example",
    "Gender": "Male",
    "HouseholdId": 1,
    "Id": 1,
    "InformalName": "example",
    "IsFavorite": true,
    "IsHeadOfHousehold": true,
    "IsInHousehold": true,
    "JobTitle": "example",
    "LastName": "example",
    "LinkedInId": "example",
    "Membership": [],
    "MiddleName": "example",
    "PhoneIds": [],
    "PreferredCommunicationChannel": "Email",
    "Prefix": "example",
    "PrimaryAddress": {
      "AccountId": 1,
      "AuditTrail": {
        "CreatedDate": "example",
        "CreatedName": "example",
        "LastModifiedDate": "example",
        "LastModifiedName": "example"
      },
      "City": "example",
      "Country": "example",
      "CountryCode": "example",
      "Id": 1,
      "IsBad": true,
      "IsPrimary": true,
      "PostalCode": "example",
      "State": "example",
      "StateAbbreviation": "example",
      "Street": "example",
      "Type": "Home"
    },
    "PrimaryEmail": {
      "AccountId": 1,
      "AuditTrail": {
        "CreatedDate": "example",
        "CreatedName": "example",
        "LastModifiedDate": "example",
        "LastModifiedName": "example"
      },
      "Id": 1,
      "IsBad": true,
      "IsPrimary": true,
      "Type": "Home",
      "Value": "example"
    },
    "PrimaryPhone": {
      "AccountId": 1,
      "AuditTrail": {
        "CreatedDate": "example",
        "CreatedName": "example",
        "LastModifiedDate": "example",
        "LastModifiedName": "example"
      },
      "Extension": "example",
      "Id": 1,
      "IsPrimary": true,
      "Number": "example",
      "Type": "Home"
    },
    "ProfilePictureType": "None",
    "RecognitionName": "example",
    "Status": "Active",
    "Suffix": "example",
    "TwitterId": "example",
    "Type": "Individual",
    "Website": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Get current user

Get current user. Returns the full service response for the connected account.

Inputs

None.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "BccEmail": "example",
    "Email": "example",
    "Id": 1,
    "IsActive": true,
    "Name": "example",
    "PendingEmail": "example",
    "PermissionLevel": "Admin",
    "Phone": "example",
    "SendTaskEmails": true,
    "UserName": "example",
    "UserTimeZone": {
      "Id": "example",
      "Name": "example",
      "UtcOffset": "example"
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get fund

Get fund. Returns the full service response for the connected account.

Inputs

IdidnumberRequired
The ID of the fund to return.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "DefaultQuickbooksAccountId": 1,
    "GeneralLedgerClass": "example",
    "Id": 1,
    "IsActive": true,
    "IsDefault": true,
    "Name": "example",
    "QuickbooksAccountIds": [],
    "SortIndex": 1
  },
  "has_more": false,
  "next_cursor": null
}

Get household

Get household. Returns the full service response for the connected account.

Inputs

IdidnumberRequired
The ID of the household.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "AccountNumber": 1,
    "AuditTrail": {
      "CreatedDate": "example",
      "CreatedName": "example",
      "LastModifiedDate": "example",
      "LastModifiedName": "example"
    },
    "CommunicationRestrictions": [],
    "EngagementScore": "Low",
    "EnvelopeName": "example",
    "FormalName": "example",
    "FullName": "example",
    "HeadId": 1,
    "Id": 1,
    "InformalName": "example",
    "IsFavorite": true,
    "MemberIds": [],
    "RecognitionName": "example",
    "SortName": "example",
    "Status": "Active",
    "Type": "Household"
  },
  "has_more": false,
  "next_cursor": null
}

Get interaction

Get interaction. Returns the full service response for the connected account.

Inputs

IdidnumberRequired
The ID of the interaction to return.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "AccountId": 1,
    "AttachmentIds": [],
    "AuditTrail": {
      "CreatedDate": "example",
      "CreatedName": "example",
      "LastModifiedDate": "example",
      "LastModifiedName": "example"
    },
    "Channel": "Email",
    "CustomValues": [],
    "Date": "example",
    "EmailAddress": "example",
    "Id": 1,
    "IsBcc": true,
    "IsEngagementSurveyEmail": true,
    "IsEngagementSurveyResponse": true,
    "IsInbound": true,
    "LetterAttachmentIds": [],
    "Note": "example",
    "Purpose": "Acknowledgement",
    "Subject": "example",
    "SurveyEmailInteractionId": 1,
    "SurveyLapsedResponses": [],
    "SurveyResponseInteractionId": 1,
    "TweetId": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Get note

Get note. Returns the full service response for the connected account.

Inputs

IdidnumberRequired
The ID of the note to return.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "AccountId": 1,
    "AttachmentIds": [],
    "AuditTrail": {
      "CreatedDate": "example",
      "CreatedName": "example",
      "LastModifiedDate": "example",
      "LastModifiedName": "example"
    },
    "CustomValues": [],
    "Date": "example",
    "Id": 1,
    "Note": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Get organization

Get organization. Returns the full service response for the connected account.

Inputs

None.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "AccountingIntegration": "Aplos",
    "BaseLicenseProvider": "Bloomerang",
    "CurrentFiscalYearStartDate": "example",
    "Flavor": "Customer",
    "Id": "example",
    "Name": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Get transaction

Get transaction. Returns the full service response for the connected account.

Inputs

IdidnumberRequired
The ID of the transaction.

Outputs

dataobject
The transaction record returned by the API.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "AccountId": 1,
    "Amount": 1,
    "AttachmentIds": [],
    "AuditTrail": {
      "CreatedDate": "example",
      "CreatedName": "example",
      "LastModifiedDate": "example",
      "LastModifiedName": "example"
    },
    "CheckDate": "example",
    "CheckNumber": "example",
    "CreditCardExpMonth": 1,
    "CreditCardExpYear": 1,
    "CreditCardLastFourDigits": "example",
    "CreditCardType": "Visa",
    "Date": "example",
    "Designations": [],
    "EftAccountType": "Checking",
    "EftLastFourDigits": "example",
    "EftRoutingNumber": "example",
    "FeeAmount": 1,
    "Id": 1,
    "InKindDescription": "example",
    "InKindMarketValue": 1,
    "InKindType": "Goods",
    "IntegrationUrl": "example",
    "IsRefunded": "Yes",
    "Method": "None",
    "NonDeductibleAmount": 1,
    "RefundIds": [],
    "TransactionNumber": 1
  },
  "has_more": false,
  "next_cursor": null
}

List appeals

List appeals. Gets one page; to see more, run it again with the next page it gives.

Inputs

Skipskipnumber
The number of items to skip before starting to collect the result set.At least 0.
Taketakenumber
The number of items to include in the result set.From 1 to 50.
Last modifiedlast_modifieddate and time
Filters to appeals last modified after the specified date
Ididlist
Filters to appeals with the IDs in the list (pipe-separated)
Is activeis_activetrue/false
Filters to either active or inactive appeals
Searchsearchtext
Filters to appeals with names that match any part of the search string

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "ResultCount": 1,
    "Results": [],
    "Start": 1,
    "Total": 1,
    "TotalFiltered": 1
  },
  "has_more": false,
  "next_cursor": null
}

List campaigns

List campaigns. Gets one page; to see more, run it again with the next page it gives.

Inputs

Skipskipnumber
The number of items to skip before starting to collect the result set.At least 0.
Taketakenumber
The number of items to include in the result set.From 1 to 50.
Last modifiedlast_modifieddate and time
Filters to campaigns last modified after the specified date
Ididlist
Filters to campaigns with the IDs in the list (pipe-separated)
Is activeis_activetrue/false
Filters to either active or inactive campaigns
Searchsearchtext
Filters to campaigns with names that match any part of the search string
Has goalhas_goaltrue/false
Filters to campaigns that have either non-zero-dollar or zero-dollar goals

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "ResultCount": 1,
    "Results": [],
    "Start": 1,
    "Total": 1,
    "TotalFiltered": 1
  },
  "has_more": false,
  "next_cursor": null
}

List constituents

List constituents. Gets one page; to see more, run it again with the next page it gives.

Inputs

Skipskipnumber
The number of items to skip before starting to collect the result set.At least 0.
Taketakenumber
The number of items to include in the result set.From 1 to 50.
Last modifiedlast_modifieddate and time
Filters to constituents last modified after the specified date
Is favoriteis_favoritetrue/false
Filters constituents to only constituents the user has favorited.
Typetypetext
Filters individuals and organizationsOne of: Individual, Organization.
Ididlist
Filters results based on the ID for the constituent.
Order byorder_bytext
Sorts by Id, CreatedDate, or LastModifiedDate (default Id).One of: Id, CreatedDate, LastModifiedDate.
Order directionorder_directiontext
Sorts the orderBy in ascending or descending order.One of: Asc, Desc.
Custom field IDcustom_field_idnumber
The custom field ID to filter by
Custom field valuecustom_field_valuetext
The custom field value to filter by

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "ResultCount": 1,
    "Results": [],
    "Start": 1,
    "Total": 1,
    "TotalFiltered": 1
  },
  "has_more": false,
  "next_cursor": null
}

List funds

List funds. Gets one page; to see more, run it again with the next page it gives.

Inputs

Skipskipnumber
The number of items to skip before starting to collect the result set.At least 0.
Taketakenumber
The number of items to include in the result set.From 1 to 50.
Ididlist
Filters to funds with the IDs in the list (pipe-separated)
Is activeis_activetrue/false
Filters to either active or inactive funds
Is defaultis_defaulttrue/false
Filters to either default or non-default funds
Searchsearchtext
Filters to funds with names that match any part of the search string

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "ResultCount": 1,
    "Results": [],
    "Start": 1,
    "Total": 1,
    "TotalFiltered": 1
  },
  "has_more": false,
  "next_cursor": null
}

List households

List households. Gets one page; to see more, run it again with the next page it gives.

Inputs

Skipskipnumber
The number of items to skip before starting to collect the result set.At least 0.
Taketakenumber
The number of items to include in the result set.From 1 to 50.
Last modifiedlast_modifieddate and time
Filters to households last modified after the specified date
Ididlist
Filters results based on the ID for the household.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "ResultCount": 1,
    "Results": [],
    "Start": 1,
    "Total": 1,
    "TotalFiltered": 1
  },
  "has_more": false,
  "next_cursor": null
}

List interactions

List interactions. Gets one page; to see more, run it again with the next page it gives.

Inputs

Skipskipnumber
The number of items to skip before starting to collect the result set.At least 0.
Taketakenumber
The number of items to include in the result set.From 1 to 50.
Channelchannellist
Filters results based on the interaction's channel.One or more of: Email, MassEmail, Phone, TextMessage, Mail, InPerson, SocialMedia, Website, Twitter, Other, EngagementSurveyEmail, EngagementSurvey.
Purposepurposelist
Filters results based on the interaction's purpose.One or more of: Acknowledgement, ImpactCultivation, Newsletter, Receipt, Solicitation, SpecialEvent, VolunteerActivity, PledgeReminder, Welcome, BenevonPointOfEntry, and 5 more.
Constituentconstituentlist
Filters results based on the Constituent ID for the interaction.
Ididlist
Filters results based on the ID for the interaction.
Order byorder_bytext
Sorts by Date, CreatedDate, or LastModifiedDate (default Date).One of: CreatedDate, Date, LastModifiedDate.
Order directionorder_directiontext
Sorts the orderBy in ascending or descending order.One of: Asc, Desc.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "ResultCount": 1,
    "Results": [],
    "Start": 1,
    "Total": 1,
    "TotalFiltered": 1
  },
  "has_more": false,
  "next_cursor": null
}

List notes

List notes. Gets one page; to see more, run it again with the next page it gives.

Inputs

Skipskipnumber
The number of items to skip before starting to collect the result set.At least 0.
Taketakenumber
The number of items to include in the result set.From 1 to 50.
Constituentconstituentlist
Filters results based on the Constituent ID for the note.
Ididlist
Filters results based on the ID for the note.
Order byorder_bytext
Sorts by Date, CreatedDate, or LastModifiedDate (default Date).One of: CreatedDate, Date, LastModifiedDate.
Order directionorder_directiontext
Sorts the orderBy in ascending or descending order.One of: Asc, Desc.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "ResultCount": 1,
    "Results": [],
    "Start": 1,
    "Total": 1,
    "TotalFiltered": 1
  },
  "has_more": false,
  "next_cursor": null
}

List transactions

List transactions. Gets one page; to see more, run it again with the next page it gives.

Inputs

Skipskipnumber
The number of items to skip before starting to collect the result set.At least 0.
Taketakenumber
The number of items to include in the result set.From 1 to 50.
Last modifiedlast_modifieddate and time
Filters to transactions last modified after the specified date
Transaction numbertransaction_numberlist
Filters results based on the transaction's transactionNumber (called Payment Number in Bloomerang CRM Reporting).
Account IDaccount_idlist
Filters results based on the account ID for the transaction.
Ididlist
Filters results based on the transaction's ID.
Typetypelist
Filters the results based on if the transaction has at least one of the given designation typesOne or more of: Donation, Pledge, PledgePayment, RecurringDonation, RecurringDonationPayment.
Min amountmin_amountnumber
Filters results based on the transaction's amount (inclusive).
Max amountmax_amountnumber
Filters results based on the transaction's amount (inclusive).
Order byorder_bytext
Sorts by Amount, Date, CreatedDate, or LastModifiedDate (default Date).One of: Amount, CreatedDate, Date, LastModifiedDate.
Order directionorder_directiontext
Sorts the orderBy in ascending or descending order (default descending).One of: Asc, Desc.
Custom field IDcustom_field_idnumber
The custom field ID to filter by
Custom field valuecustom_field_valuetext
The custom field value to filter by

Outputs

dataobject
Transactions matching the query, including paging totals and every returned record.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "ResultCount": 1,
    "Results": [],
    "Start": 1,
    "Total": 1,
    "TotalFiltered": 1
  },
  "has_more": false,
  "next_cursor": null
}

Search constituents

Search constituents. Gets one page; to see more, run it again with the next page it gives.

Inputs

Skipskipnumber
The number of items to skip before starting to collect the result set.At least 0.
Taketakenumber
The number of items to include in the result set.From 1 to 50.
Searchsearchtext
The text to search
Typetypetext
Filters individuals, organizations, and householdsOne of: Individual, Organization, Household.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "ResultCount": 1,
    "Results": [],
    "Start": 1,
    "Total": 1,
    "TotalFiltered": 1
  },
  "has_more": false,
  "next_cursor": null
}

Update constituent

Update constituent. Empty fields keep their current values.

Inputs

IdidnumberRequired
The ID of the constituent to return.
Typetypetext
Type.One of: Individual, Organization.
Statusstatustext
Status.One of: Active, Inactive, Deceased.
First namefirst_nametext
FirstName.
Last namelast_nametext
LastName.
Middle namemiddle_nametext
MiddleName.
Prefixprefixtext
Must match a prefix in the Bloomerang CRM
Suffixsuffixtext
Must match a suffix in the Bloomerang CRM
Full namefull_nametext
FullName.
Informal nameinformal_nametext
InformalName.
Formal nameformal_nametext
FormalName.
Envelope nameenvelope_nametext
EnvelopeName.
Recognition namerecognition_nametext
RecognitionName.
Job titlejob_titletext
JobTitle.
Employeremployertext
Employer.
Websitewebsitetext
Website.
Facebook IDfacebook_idtext
FacebookId.
Twitter IDtwitter_idtext
TwitterId.
Linked in IDlinked_in_idtext
LinkedInId.
Gendergendertext
Gender.One of: Male, Female, Other.
Birthdatebirthdatedate
Birthdate.
Profile picture typeprofile_picture_typetext
ProfilePictureType.One of: None, Custom, Twitter.
Primary addressprimary_addressobject
Additional structured primary address. Use the documented fields.
Secondary addressessecondary_addresseslist
Non-primary addresses
Primary emailprimary_emailobject
Additional structured primary email. Use the documented fields.
Secondary emailssecondary_emailslist
Non-primary email addresses
Primary phoneprimary_phoneobject
Additional structured primary phone. Use the documented fields.
Secondary phonessecondary_phoneslist
Non-primary phones
Full custom profile imagefull_custom_profile_imagetext
The full picture File Attachment. Note that a Constituent can only have one Profile Picture; adding a new one will remove the old one.
Cropped custom profile imagecropped_custom_profile_imagetext
The cropped picture File Attachment. Note that a Constituent can only have one Profile Picture; adding a new one will remove the old one.
Custom valuescustom_valueslist
CustomValues.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "AccountNumber": 1,
    "AddressIds": [],
    "AuditTrail": {
      "CreatedDate": "example",
      "CreatedName": "example",
      "LastModifiedDate": "example",
      "LastModifiedName": "example"
    },
    "Birthdate": "example",
    "CommunicationRestrictions": [],
    "CommunicationRestrictionsUpdateReason": "example",
    "CroppedCustomProfileImageId": 1,
    "CroppedCustomProfileImageUrl": "example",
    "CustomEmailInterests": [],
    "CustomValues": [],
    "DonorSearchInfo": {
      "AnnualFundLikelihood": "Low",
      "BusinessExecutive": true,
      "BusinessRevenues": 1,
      "DateTimeScreenedUtc": "example",
      "DemocraticContributionCount": 1,
      "Foundations": "example",
      "GenerosityScore": "Low",
      "GenerosityScoreLabel": "example",
      "Id": 1,
      "IndependentContributionCount": 1,
      "LargestGiftMax": 1,
      "LargestGiftMin": 1,
      "LargestGiftOrg": "example",
      "MajorGiftLikelihood": "Low",
      "NamesScreened": "example",
      "Quality": "Low",
      "RealEstateCount": 1,
      "RepublicanContributionCount": 1,
      "TotalGiftAmount": 1,
      "WealthAskMax": 1,
      "WealthAskMin": 1
    },
    "EmailIds": [],
    "EmailInterestType": "All",
    "EmailInterestsUpdateReason": "example",
    "Employer": "example",
    "EngagementScore": "Low",
    "EngagementScoreLabel": "example",
    "EnvelopeName": "example",
    "FacebookId": "example",
    "FirstName": "example",
    "FormalName": "example",
    "FullCustomProfileImageId": 1,
    "FullCustomProfileImageUrl": "example",
    "FullName": "example",
    "Gender": "Male",
    "HouseholdId": 1,
    "Id": 1,
    "InformalName": "example",
    "IsFavorite": true,
    "IsHeadOfHousehold": true,
    "IsInHousehold": true,
    "JobTitle": "example",
    "LastName": "example",
    "LinkedInId": "example",
    "MiddleName": "example",
    "PhoneIds": [],
    "PreferredCommunicationChannel": "Email",
    "Prefix": "example",
    "PrimaryAddress": {
      "AccountId": 1,
      "AuditTrail": {
        "CreatedDate": "example",
        "CreatedName": "example",
        "LastModifiedDate": "example",
        "LastModifiedName": "example"
      },
      "City": "example",
      "Country": "example",
      "CountryCode": "example",
      "Id": 1,
      "IsBad": true,
      "IsPrimary": true,
      "PostalCode": "example",
      "State": "example",
      "StateAbbreviation": "example",
      "Street": "example",
      "Type": "Home"
    },
    "PrimaryEmail": {
      "AccountId": 1,
      "AuditTrail": {
        "CreatedDate": "example",
        "CreatedName": "example",
        "LastModifiedDate": "example",
        "LastModifiedName": "example"
      },
      "Id": 1,
      "IsBad": true,
      "IsPrimary": true,
      "Type": "Home",
      "Value": "example"
    },
    "PrimaryPhone": {
      "AccountId": 1,
      "AuditTrail": {
        "CreatedDate": "example",
        "CreatedName": "example",
        "LastModifiedDate": "example",
        "LastModifiedName": "example"
      },
      "Extension": "example",
      "Id": 1,
      "IsPrimary": true,
      "Number": "example",
      "Type": "Home"
    },
    "ProfilePictureType": "None",
    "RecognitionName": "example",
    "Status": "Active",
    "Suffix": "example",
    "TwitterId": "example",
    "Type": "Individual",
    "Website": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Update note

Update note. Empty fields keep their current values.

Inputs

IdidnumberRequired
The ID of the note to return.
Account IDaccount_idnumber
The ID of the constituent used in the API (not to be confused with accountNumber)
Datedatedate
Date.
Notenotetext
Note.
Custom valuescustom_valueslist
CustomValues.
Attachmentsattachmentslist
Attachments.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "AccountId": 1,
    "AttachmentIds": [],
    "AuditTrail": {
      "CreatedDate": "example",
      "CreatedName": "example",
      "LastModifiedDate": "example",
      "LastModifiedName": "example"
    },
    "CustomValues": [],
    "Date": "example",
    "Id": 1,
    "Note": "example"
  },
  "has_more": false,
  "next_cursor": null
}

On this page