Get client tag

GET /api/v2/companysettings/clienttags/{TagGUID}

Bearer auth

This endpoint allows users to retrieve details for a company client tag.

Path parameters

TagGUID string(uuid) Required

The GUID of the client tag to update.

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
  
  TagGUID string(uuid)
  
  CompanyID integer
  
  TagName string
  
  TagColour string
  
  TotalUsingTag integer
  
  FormattedValues object
404 application/json

Client tag not found
Hide response attributes Show response attributes object
- success boolean
  
  Default value is false.
- message string

GET /api/v2/companysettings/clienttags/{TagGUID}

curl \
 -X GET https://api.fincalc.co.uk/api/v2/companysettings/clienttags/{TagGUID} \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "success": true,
  "data": {
    "TagGUID": "3F0B1C88-6D80-4C17-BB3E-1D68E6D26405",
    "CompanyID": 2,
    "TagName": "Accumulation",
    "TagColour": "#000FFF",
    "TotalUsingTag": 14,
    "FormattedValues": {
      "CompanyID": "FinCalc"
    }
  }
}

Response examples (404)

{
  "success": false,
  "message": "Company client tag not found."
}