GIgivebutter
Households

List all households

Changed on
get/v1/households

Request

  • Base URL
    https://api.givebutter.com
  • URL
    https://api.givebutter.com/v1/households
  • Auth
    HTTP bearer

Query parameters

headContactIdstring nullable
contactsstring nullable
querystring nullable
sortBystring nullable
sortByDescstring nullable
pagestring

Response

Array of HouseholdResource

idinteger required
namestring required
head_contact_idinteger nullable required
account_idinteger required
envelope_namestring nullable required
notestring nullable required
created_atstring date-time nullable required
updated_atstring date-time nullable required

Changes

  • 7793d61ca0daRevision changes
    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status