Get clients household

GET /api/v2/clients/{ClientGUID}/household

Bearer auth

Get details of clients household.

Path parameters

ClientGUID string(uuid) Required

The GUID of the client whose household information you want to retrieve.

Responses

200 application/json

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

Client not found.
Hide response attributes Show response attributes object
- success boolean
  
  Default value is false.
- message string
403 application/json

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

GET /api/v2/clients/{ClientGUID}/household

curl \
 -X GET https://api.fincalc.co.uk/api/v2/clients/{ClientGUID}/household \
 -H "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 (404)

{
  "success": false,
  "message": "Client not found."
}

Response examples (403)

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