Get relationships

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

This endpoint retrieves a list of a clients relationships. The response data will be an array of objects with each object being the data for one relationship.

Path parameters

ClientGUID string(uuid) Required

The GUID of the client whose relationship details you want to retrieve.

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
  
  FirstName string
  
  Surname string
  
  ClientGUID string(uuid)
  
  RelationshipID integer
  
  FormattedValues object
  
  Additional properties are allowed.
403 application/json

Permission error.
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/clients/{ClientGUID}/relationships

curl \
 -X GET https://api.fincalc.co.uk/api/v2/clients/{ClientGUID}/relationships \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "success": true,
  "data": [
    {
      "FirstName": "Mark",
      "Surname": "Phillips",
      "ClientGUID": "3F0B1C88-6D80-4C17-BB3E-1D68E6D26405",
      "RelationshipID": 1,
      "FormattedValues": {
        "ClientGUID": "Mark Phillips",
        "RelationshipID": "Spouse"
      }
    }
  ]
}

Response examples (403)

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

Response examples (404)

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