Get household

GET /api/v2/household/{HouseholdGUID}

Bearer auth

This endpoint retrieves details of the household.

Path parameters

HouseholdGUID string(uuid) Required

The HouseholdGUID of the client

Query parameters

ExcludeFormattedValues string

If set to any value, formatted values will be excluded from the response.

Responses

200 application/json

Success
Hide response attributes Show response attributes object
- success boolean
  
  Default value is true.
- data object
  
  Hide data attributes Show data attributes object
  
  HouseholdGUID string(uuid)
  
  ClientGUID string(uuid)
  
  RelatedClientGUID string(uuid)
  
  HouseholdLabel string(uuid)
  
  BaselineAssumptionSetGUID string(uuid)
  
  FormattedValues object
403 application/json

Permission error.
Hide response attributes Show response attributes object
- success boolean
  
  Default value is false.
- message string

GET /api/v2/household/{HouseholdGUID}

curl \
 --request GET 'https://api.fincalc.co.uk/api/v2/household/{HouseholdGUID}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "success": true,
  "data": {
    "HouseholdGUID": "5EF25021-1B07-484E-A730-FBF0FD28BA86",
    "ClientGUID": "3F0B1C88-6D80-4C17-BB3E-1D68E6D26405",
    "RelatedClientGUID": "7299F843-7E1B-42D2-A786-1E52E2F95D0F",
    "HouseholdLabel": "Tom & Tina Smith",
    "BaselineAssumptionSetGUID": "8E62A29D-75E1-48C1-9F34-FD7C3BFB81F7",
    "FormattedValues": {
      "ClientGUID": "Tom Smith",
      "RelatedClientGUID": "Tina Smith",
      "BaselineAssumptionSetGUID": "FinCalc Default Fixed 0%"
    }
  }
}

Response examples (403)

{
  "success": false,
  "message": "You do not have permission to view the household."
}