Get company and system supplied client tags

GET /api/v2/companysettings/clienttags
Bearer auth

This endpoint retrieves a list of all company client tags (including system supplied). The response data will be an array of objects with each object being the data for one client tag.

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
      • CompanyClientTags array[object]
        Hide CompanyClientTags attributes Show CompanyClientTags attributes object
        • TagGUID string(uuid)
        • CompanyGUID string(uuid)
        • TagName string
        • TagColour string
        • TotalUsingTag integer
        • FormattedValues object
          Hide FormattedValues attribute Show FormattedValues attribute object
          • CompanyGUID string
      • SystemSuppliedClientTags array[object]
        Hide SystemSuppliedClientTags attributes Show SystemSuppliedClientTags attributes object
        • TagGUID string(uuid)
        • TagName string
GET /api/v2/companysettings/clienttags 
curl \
 --request GET 'https://api.fincalc.co.uk/api/v2/companysettings/clienttags' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "success": true,
  "data": {
    "CompanyClientTags": [
      {
        "TagGUID": "72204219-8DFF-0F26-B66E-39C4F9DD5799",
        "CompanyGUID": 2,
        "TagName": "Accumulation",
        "TagColour": "#ff665b",
        "TotalUsingTag": 7,
        "FormattedValues": {
          "CompanyGUID": "O&M Product Team"
        }
      }
    ],
    "SystemSuppliedClientTags": [
      {
        "TagGUID": "3C000332-2AD9-5F5D-DE6F-1D296E916A85",
        "TagName": "Client Portal"
      },
      {
        "TagGUID": "758239ED-CCF4-D16E-FBAB-43E172B20455",
        "TagName": "Cashflow Modeller"
      },
      {
        "TagGUID": "A64FB7B3-FA6E-5FC8-D970-C335D4DB79B2",
        "TagName": "IHT Modeller"
      },
      {
        "TagGUID": "77C5D1DE-5F08-8242-FD35-E9681C38DC8E",
        "TagName": "Retirement Modeller"
      },
      {
        "TagGUID": "09DA4F17-7F4D-489C-95C6-CCB799953BB2",
        "TagName": "Transvas with TVC"
      },
      {
        "TagGUID": "14F30124-BE78-EFAF-9D8F-6494408468FD",
        "TagName": "My Clients"
      },
      {
        "TagGUID": "5A6D69CD-310D-4E37-508B-16F0F0ADD676",
        "TagName": "Shared Clients"
      },
      {
        "TagGUID": "8F6B4B37-99AC-C97C-4EA9-DBFA098F7A33",
        "TagName": "Team Clients"
      }
    ]
  }
}