Changes To The Constituent API

John Lyons

The Constituent API was updated on 9/28/2016. See our Changelog entries for more information.

Breaking Change Planned

We will change the fundraisers property on the action entity so that it contains a list of strings populated with the constituent_id of fundraisers instead of an array of action fundraiser entities.

 

Changed

• The Constituent (List) endpoint now includes the option to select specific properties on its return object by using the optional fields query parameter. This can reduce the response payload size and improve the response time.
• The Constituent (List) endpoint no longer returns deceased constituents by default. Instead, they are included by setting the new include_deceased option to true.
• The Communication preference (List) endpoint can now be paginated using the new limit and offset query parameters. If not specified, the default limit is 10000.
• We changed the following query string parameters to snake case:
  • includeInactive is now include_inactive on Constituent (List), Email address (List), Online presence (List), Phone (List), Rating (List), Rating categories (Get), and Rating sources (Get).
  • categoryName is now category_name on Constituent custom field category values (Get).
  • searchText is now search_text on Constituent (Search).