Households

GET /v2/households

This endpoint allows external users to retrieve a list of households or household IDs associated with the current user. It returns a list of ID-s and names of households/households associated with the current user.

The users can access households that are permitted to them based on their role and account access.

Households Headers

Authorization required	The access token.

Households Parameters

page integer	Desired page number, default is 0.
page_size integer	Desired number of entries per page, defaults is 100, max value is 1000.
name_pattern string	A case-insensitive pattern which (if specified) must be contained within household or household name. If you specify the name pattern, you will receive the information only for this Household. For example, Smith.

Households Response Object Fields

id string, required	The ID of the household.
name string	The name of the household. For example, The Rogers Family.

GET /api/v1/households (deprecating soon)

This endpoint retrieves the list of households/household IDs for the current user. It returns a list of IDs and names of households/household IDs associated with the current user.

The users can access households that are permitted to them based on their role and account access.

Note: If you specify the name_pattern in your request, you will receive the information only for this Household. If you do not specify the name_pattern in your request, you will receive the information about all Households.

Households Headers

Authorization required	The access token.
X-API-Request-ID string	The household-provided request ID.

Households Parameters

page integer	Desired page number, default is 0.
page_size integer	Desired number of entries per page, defaults is 100, max value is 1000.
name_pattern string	A case-insensitive pattern which (if specified) must be contained within household or household name. If you specify the name pattern, you will receive the information only for this Household. For example, Smith.

Households Response Object Fields

id string, required	The ID of the household.
name string	The name of the household. For example, The Rogers Family.

Next, the endpoint GET altruist-open-api/accounts by household can be used to get all active accounts data from a household by replacing the value [HOUSE_HOLD_ID] in the endpoint URL by the household ID.