Get event options

GET /api/v2/household/{HouseholdGUID}/events/options
Bearer auth

This endpoint provides a comprehensive list of valid options for each field. The response example displayed is only a summarised version of the actual list. By using this endpoint, a complete list of available options for each field can be retrieved.

Path parameters

  • HouseholdGUID string(uuid) Required

    The GUID of the household you wish to get options for.

Responses

GET /api/v2/household/{HouseholdGUID}/events/options 
curl \
 -X GET https://api.fincalc.co.uk/api/v2/household/{HouseholdGUID}/events/options \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "success": true,
  "data": {
    "EventBasis": {
      "1": "Date",
      "2": "Age",
      "3": "Linked to another event"
    },
    "OffsetBasis": {
      "1": "Before",
      "2": "After"
    },
    "LinkedEventGUID": {
      "8C31BBA6-9C63-4F6F-BD6E-2C63B63B3B3B": "Tony's State Pension Age",
      "1A2B3C4D-5E6F-7G8H-9I0J-1K2L3M4N5O6P": "Tina's State Pension Age",
      "E8F8B580-0D24-45B7-9DA1-8F11F64B6909": "Tina's Birthday"
    }
  }
}
Response examples (403) 
{
  "success": false,
  "message": "You do not have permission to view the household."
}
Response examples (404) 
{
  "success": false,
  "message": "Household not found."
}