# Bloomerang

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

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/bloomerang

## Actions

### Create constituent

Create constituent.

**Inputs**

- Type (`type`, text, required): Type. One of: `Individual`, `Organization`.
- Status (`status`, text): Status. One of: `Active`, `Inactive`, `Deceased`.
- First name (`first_name`, text): FirstName.
- Last name (`last_name`, text): LastName.
- Middle name (`middle_name`, text): MiddleName.
- Prefix (`prefix`, text): Must match a prefix in the Bloomerang CRM
- Suffix (`suffix`, text): Must match a suffix in the Bloomerang CRM
- Full name (`full_name`, text): FullName.
- Informal name (`informal_name`, text): InformalName.
- Formal name (`formal_name`, text): FormalName.
- Envelope name (`envelope_name`, text): EnvelopeName.
- Recognition name (`recognition_name`, text): RecognitionName.
- Job title (`job_title`, text): JobTitle.
- Employer (`employer`, text): Employer.
- Website (`website`, text): Website.
- Facebook ID (`facebook_id`, text): FacebookId.
- Twitter ID (`twitter_id`, text): TwitterId.
- Linked in ID (`linked_in_id`, text): LinkedInId.
- Gender (`gender`, text): Gender. One of: `Male`, `Female`, `Other`.
- Birthdate (`birthdate`, date): Birthdate.
- Profile picture type (`profile_picture_type`, text): ProfilePictureType. One of: `None`, `Custom`, `Twitter`.
- Primary address (`primary_address`, object): Additional structured primary address. Use the documented fields.
- Secondary addresses (`secondary_addresses`, list): Non-primary addresses
- Primary email (`primary_email`, object): Additional structured primary email. Use the documented fields.
- Secondary emails (`secondary_emails`, list): Non-primary email addresses
- Primary phone (`primary_phone`, object): Additional structured primary phone. Use the documented fields.
- Secondary phones (`secondary_phones`, list): Non-primary phones
- Full custom profile image (`full_custom_profile_image`, text): 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 image (`cropped_custom_profile_image`, text): 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 values (`custom_values`, list): CustomValues.
- Household ID (`household_id`, number): The ID of the household this constituent is in (not to be confused with AccountNumber)
- Preferred communication channel (`preferred_communication_channel`, text): PreferredCommunicationChannel. One of: `Email`, `Phone`, `TextMessage`, `Mail`.
- Communication restrictions (`communication_restrictions`, list): CommunicationRestrictions. One or more of: `DoNotCall`, `DoNotMail`, `DoNotSolicit`.
- Email interest type (`email_interest_type`, text): EmailInterestType. One of: `All`, `Custom`, `OptedOut`.
- Custom email interest IDs (`custom_email_interest_ids`, list): IDs for custom email interests if the email interest type is Custom

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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 ID (`account_id`, number, required): The ID of the constituent used in the API (not to be confused with accountNumber)
- Date (`date`, date, required): Date.
- Note (`note`, text, required): Note.
- Custom values (`custom_values`, list): CustomValues.
- Attachments (`attachments`, list): Attachments.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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**

- Id (`id`, number, required): The ID of the constituent to return.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": {
    "Deleted": true,
    "Id": 1,
    "Type": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Delete note

Delete note.

**Inputs**

- Id (`id`, number, required): The ID of the note to return.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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**

- Id (`id`, number, required): The ID of the appeal to return.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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**

- Id (`id`, number, required): The ID of the campaign to return.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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**

- Id (`id`, number, required): The ID of the constituent to return.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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**

- Id (`id`, number, required): The ID of the fund to return.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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**

- Id (`id`, number, required): The ID of the household.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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**

- Id (`id`, number, required): The ID of the interaction to return.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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**

- Id (`id`, number, required): The ID of the note to return.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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**

- Id (`id`, number, required): The ID of the transaction.

**Outputs**

- `data` (object): The transaction record returned by the API.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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**

- Skip (`skip`, number): The number of items to skip before starting to collect the result set. At least 0.
- Take (`take`, number): The number of items to include in the result set. From 1 to 50.
- Last modified (`last_modified`, date and time): Filters to appeals last modified after the specified date
- Id (`id`, list): Filters to appeals with the IDs in the list (pipe-separated)
- Is active (`is_active`, true/false): Filters to either active or inactive appeals
- Search (`search`, text): Filters to appeals with names that match any part of the search string

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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**

- Skip (`skip`, number): The number of items to skip before starting to collect the result set. At least 0.
- Take (`take`, number): The number of items to include in the result set. From 1 to 50.
- Last modified (`last_modified`, date and time): Filters to campaigns last modified after the specified date
- Id (`id`, list): Filters to campaigns with the IDs in the list (pipe-separated)
- Is active (`is_active`, true/false): Filters to either active or inactive campaigns
- Search (`search`, text): Filters to campaigns with names that match any part of the search string
- Has goal (`has_goal`, true/false): Filters to campaigns that have either non-zero-dollar or zero-dollar goals

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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**

- Skip (`skip`, number): The number of items to skip before starting to collect the result set. At least 0.
- Take (`take`, number): The number of items to include in the result set. From 1 to 50.
- Last modified (`last_modified`, date and time): Filters to constituents last modified after the specified date
- Is favorite (`is_favorite`, true/false): Filters constituents to only constituents the user has favorited.
- Type (`type`, text): Filters individuals and organizations. One of: `Individual`, `Organization`.
- Id (`id`, list): Filters results based on the ID for the constituent.
- Order by (`order_by`, text): Sorts by Id, CreatedDate, or LastModifiedDate (default Id). One of: `Id`, `CreatedDate`, `LastModifiedDate`.
- Order direction (`order_direction`, text): Sorts the orderBy in ascending or descending order. One of: `Asc`, `Desc`.
- Custom field ID (`custom_field_id`, number): The custom field ID to filter by
- Custom field value (`custom_field_value`, text): The custom field value to filter by

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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**

- Skip (`skip`, number): The number of items to skip before starting to collect the result set. At least 0.
- Take (`take`, number): The number of items to include in the result set. From 1 to 50.
- Id (`id`, list): Filters to funds with the IDs in the list (pipe-separated)
- Is active (`is_active`, true/false): Filters to either active or inactive funds
- Is default (`is_default`, true/false): Filters to either default or non-default funds
- Search (`search`, text): Filters to funds with names that match any part of the search string

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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**

- Skip (`skip`, number): The number of items to skip before starting to collect the result set. At least 0.
- Take (`take`, number): The number of items to include in the result set. From 1 to 50.
- Last modified (`last_modified`, date and time): Filters to households last modified after the specified date
- Id (`id`, list): Filters results based on the ID for the household.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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**

- Skip (`skip`, number): The number of items to skip before starting to collect the result set. At least 0.
- Take (`take`, number): The number of items to include in the result set. From 1 to 50.
- Channel (`channel`, list): Filters results based on the interaction's channel. One or more of: `Email`, `MassEmail`, `Phone`, `TextMessage`, `Mail`, `InPerson`, `SocialMedia`, `Website`, `Twitter`, `Other`, `EngagementSurveyEmail`, `EngagementSurvey`.
- Purpose (`purpose`, list): 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.
- Constituent (`constituent`, list): Filters results based on the Constituent ID for the interaction.
- Id (`id`, list): Filters results based on the ID for the interaction.
- Order by (`order_by`, text): Sorts by Date, CreatedDate, or LastModifiedDate (default Date). One of: `CreatedDate`, `Date`, `LastModifiedDate`.
- Order direction (`order_direction`, text): Sorts the orderBy in ascending or descending order. One of: `Asc`, `Desc`.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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**

- Skip (`skip`, number): The number of items to skip before starting to collect the result set. At least 0.
- Take (`take`, number): The number of items to include in the result set. From 1 to 50.
- Constituent (`constituent`, list): Filters results based on the Constituent ID for the note.
- Id (`id`, list): Filters results based on the ID for the note.
- Order by (`order_by`, text): Sorts by Date, CreatedDate, or LastModifiedDate (default Date). One of: `CreatedDate`, `Date`, `LastModifiedDate`.
- Order direction (`order_direction`, text): Sorts the orderBy in ascending or descending order. One of: `Asc`, `Desc`.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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**

- Skip (`skip`, number): The number of items to skip before starting to collect the result set. At least 0.
- Take (`take`, number): The number of items to include in the result set. From 1 to 50.
- Last modified (`last_modified`, date and time): Filters to transactions last modified after the specified date
- Transaction number (`transaction_number`, list): Filters results based on the transaction's transactionNumber (called Payment Number in Bloomerang CRM Reporting).
- Account ID (`account_id`, list): Filters results based on the account ID for the transaction.
- Id (`id`, list): Filters results based on the transaction's ID.
- Type (`type`, list): Filters the results based on if the transaction has at least one of the given designation types. One or more of: `Donation`, `Pledge`, `PledgePayment`, `RecurringDonation`, `RecurringDonationPayment`.
- Min amount (`min_amount`, number): Filters results based on the transaction's amount (inclusive).
- Max amount (`max_amount`, number): Filters results based on the transaction's amount (inclusive).
- Order by (`order_by`, text): Sorts by Amount, Date, CreatedDate, or LastModifiedDate (default Date). One of: `Amount`, `CreatedDate`, `Date`, `LastModifiedDate`.
- Order direction (`order_direction`, text): Sorts the orderBy in ascending or descending order (default descending). One of: `Asc`, `Desc`.
- Custom field ID (`custom_field_id`, number): The custom field ID to filter by
- Custom field value (`custom_field_value`, text): The custom field value to filter by

**Outputs**

- `data` (object): Transactions matching the query, including paging totals and every returned record.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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**

- Skip (`skip`, number): The number of items to skip before starting to collect the result set. At least 0.
- Take (`take`, number): The number of items to include in the result set. From 1 to 50.
- Search (`search`, text): The text to search
- Type (`type`, text): Filters individuals, organizations, and households. One of: `Individual`, `Organization`, `Household`.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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**

- Id (`id`, number, required): The ID of the constituent to return.
- Type (`type`, text): Type. One of: `Individual`, `Organization`.
- Status (`status`, text): Status. One of: `Active`, `Inactive`, `Deceased`.
- First name (`first_name`, text): FirstName.
- Last name (`last_name`, text): LastName.
- Middle name (`middle_name`, text): MiddleName.
- Prefix (`prefix`, text): Must match a prefix in the Bloomerang CRM
- Suffix (`suffix`, text): Must match a suffix in the Bloomerang CRM
- Full name (`full_name`, text): FullName.
- Informal name (`informal_name`, text): InformalName.
- Formal name (`formal_name`, text): FormalName.
- Envelope name (`envelope_name`, text): EnvelopeName.
- Recognition name (`recognition_name`, text): RecognitionName.
- Job title (`job_title`, text): JobTitle.
- Employer (`employer`, text): Employer.
- Website (`website`, text): Website.
- Facebook ID (`facebook_id`, text): FacebookId.
- Twitter ID (`twitter_id`, text): TwitterId.
- Linked in ID (`linked_in_id`, text): LinkedInId.
- Gender (`gender`, text): Gender. One of: `Male`, `Female`, `Other`.
- Birthdate (`birthdate`, date): Birthdate.
- Profile picture type (`profile_picture_type`, text): ProfilePictureType. One of: `None`, `Custom`, `Twitter`.
- Primary address (`primary_address`, object): Additional structured primary address. Use the documented fields.
- Secondary addresses (`secondary_addresses`, list): Non-primary addresses
- Primary email (`primary_email`, object): Additional structured primary email. Use the documented fields.
- Secondary emails (`secondary_emails`, list): Non-primary email addresses
- Primary phone (`primary_phone`, object): Additional structured primary phone. Use the documented fields.
- Secondary phones (`secondary_phones`, list): Non-primary phones
- Full custom profile image (`full_custom_profile_image`, text): 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 image (`cropped_custom_profile_image`, text): 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 values (`custom_values`, list): CustomValues.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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**

- Id (`id`, number, required): The ID of the note to return.
- Account ID (`account_id`, number): The ID of the constituent used in the API (not to be confused with accountNumber)
- Date (`date`, date): Date.
- Note (`note`, text): Note.
- Custom values (`custom_values`, list): CustomValues.
- Attachments (`attachments`, list): Attachments.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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
}
```
