Get Current User Information

GET /api/v2/user

Bearer auth

Get details of current user.

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
  
  UserGUID string(uuid)
  
  PersonGUID string(uuid)
  
  CompanyGUID string(uuid)
  
  Locked integer
  
  SecurityProfileGUID string(uuid)
  
  LicenceEnabled integer
  
  Adviser integer
  
  TeamGUID string(uuid)
  
  UserLicenceType integer
  
  FirstName string
  
  LastName string
  
  Email string(email)
  
  MobilePhone string
  
  FormattedValues object
401 application/json

User account is locked.
Hide response attributes Show response attributes object
- success boolean
  
  Default value is false.
- message string
404 application/json

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

GET /api/v2/user

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

Response examples (200)

{
  "success": true,
  "data": {
    "UserGUID": "A411CD2C-6602-4CE8-BFD6-2658AD0628BB",
    "PersonGUID": "D05426D5-1BDD-4032-A1C9-0101536A8E74",
    "CompanyGUID": "A411CD2C-6602-4CE8-BFD6-2658AD0628BB",
    "Locked": 1,
    "SecurityProfileGUID": "ACE95013-F90E-4463-ACD5-7679F9FC0C68",
    "LicenceEnabled": 1,
    "Adviser": 1,
    "TeamGUID": "11EF1721-A43C-71CA-86F2-BBE995FAD6CC",
    "UserLicenceType": 1,
    "FirstName": "James",
    "LastName": "Burton",
    "Email": "hello@example.com",
    "MobilePhone": "07777000858",
    "FormattedValues": {
      "Locked": "No",
      "Adviser": "Yes",
      "TeamGUID": "London Branch",
      "CompanyGUID": "FinCalc",
      "LicenceEnabled": "Yes",
      "UserLicenceType": "FinCalc",
      "SecurityProfileGUID": "Administrator"
    }
  }
}

Response examples (401)

{
  "success": false,
  "message": "Client authentication failed"
}

Response examples (404)

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