Get fact find templates

GET /api/v2/factfind/templates

This endpoint retrieves a list of all published fact find templates. The response data will be an array of objects, with each object being the data for one fact find template.

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 array[object]
  
  Hide data attributes Show data attributes object
  
  FactFindGUID string(uuid)
  
  FactFindName string
  
  ExpenditureListGUID string(uuid)
  
  Status integer
  
  FormattedValues object

GET /api/v2/factfind/templates

curl \
 --request GET 'https://api.fincalc.co.uk/api/v2/factfind/templates' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "success": true,
  "data": [
    {
      "FactFindGUID": "E3AEEF8D-3A6F-44B5-BA6D-8E8C7646C9D6",
      "FactFindName": "ABC's FactFind",
      "ExpenditureListGUID": "6480D2F7-0D01-4305-B43E-D24EF613FB4B",
      "Status": 3,
      "FormattedValues": {
        "Status": "Published",
        "ExpenditureListGUID": "FinCalc Default"
      }
    }
  ]
}