Get clients tags

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

Bearer auth

Get details on which tags have been added for a specific client.

Path parameters

ClientGUID string(uuid) Required

The GUID of the client from which you want to obtain the tag information.

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
  
  TagGUID string(uuid)
  
  CompanyGUID string(uuid)
  
  TagName string
  
  TagColour string
  
  FormattedValues object
403 application/json

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

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

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

curl \
 --request GET 'https://api.fincalc.co.uk/api/v2/clients/{ClientGUID}/tags' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "success": true,
  "data": [
    {
      "TagGUID": "3F0B1C88-6D80-4C17-BB3E-1D68E6D26405",
      "CompanyGUID": "72204219-8DFF-0F26-B66E-39C4F9DD5799",
      "TagName": "Accumulation",
      "TagColour": "#000FFF",
      "FormattedValues": {
        "CompanyGUID": "FinCalc"
      }
    }
  ]
}

Response examples (403)

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

Response examples (404)

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