Changes to the Constituent API

We have made the following changes to the Constituent API to include head of household information.
  • The Constituent and Constituent list endpoints now support head of household information.

     
  • The GET Relationship, GET Relationship list (Single constituent), and GET Relationship list (All constituents) endpoints now include the following properties:

     
    • is_spouse_head_of_household

       
    • is_constituent_head_of_household
These properties may be set on new relationships created through the POST Relationship endpoint and edited through the PATCH Relationship endpoint.


For more information, see the Constituent changelog.

Comments

  • I've just noticed that the ListConstituent endpoint sort parameter now appears to be expecting an array of string instead of a string, as was the case with this release. Can someone please confirm when/why this change was made as I can see this documented anywhere. Thanks.

Categories