Get all risks for Client

GET /api/v1/client/{client_uuid}/risk

Personal access token & O auth2

View all risks for a client

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

client_uuid string Required

Query parameters

include string

Comma separated list of relationships to include in the response. Valid relationships are [completed_by].
filter[uuid] string

Filter by a comma separated list of UUIDs.
sort string

Field to sort by. Valid fields are [created_at, updated_at, level, level_string, completed_at, risk_assessment_provider, time_horizon_set_at]. Negative sign to denote DESC. Defaults to 'created_at'.
per_page integer

Number of results to return with pagination (Default 15. Max 500).

Responses

200 application/json
Hide response attribute Show response attribute object
- data array[object]
  
  Hide data attributes Show data attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  level integer
  
  level_string string
  
  completed_at string
  
  completed_by object
  
  Hide completed_by attributes Show completed_by attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  firm string
  
  primary_phone_number string
  
  primary_email string
  
  current_time_entry string
  
  assigned_adviser string
  
  assigned_administrator string
  
  assigned_paraplanner string
  
  introduced_by string
  
  groups string
  
  tags string
  
  owners string
  
  first_contact_date string
  
  next_review_date string
  
  previous_review_date string
  
  anniversary_review_date string
  
  with_login boolean
  
  has_joint_account boolean
  
  can_be_deleted string
  
  joint_account_circle string
  
  ownership_percentage integer
  
  inactive_at string
  
  custom_fields string
  
  external_references string
  
  risk_assessment_provider string
  
  time_horizon string
  
  time_horizon_set_at string

GET /api/v1/client/{client_uuid}/risk

curl \
 --request GET 'https://api.plannrcrm.com/api/v1/client/6ff8f7f6-1eb3-3525-be4a-3932c805afed/risk' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"

Response examples (200)

{
  "data": [
    {
      "uuid": "1eb736bc-764c-4dd7-9dbf-e77e209fd80a",
      "level": 52,
      "created_at": "2025-06-25T15:10:41+01:00",
      "updated_at": "2025-06-25T15:10:41+01:00",
      "completed_at": "2024-06-25T15:10:41+01:00",
      "completed_by": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "bbc60cd5-11ff-4798-b38d-28d897a17b9b",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2025-06-25T15:10:41+01:00",
        "first_name": "Gareth",
        "updated_at": "2025-06-25T15:10:41+01:00",
        "with_login": true,
        "inactive_at": "2025-06-25",
        "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
        "introduced_by": "App\\Http\\Resources\\AccountResource",
        "primary_email": "App\\Http\\Resources\\ContactDetailResource",
        "can_be_deleted": "false",
        "assigned_adviser": "App\\Http\\Resources\\AccountResource",
        "next_review_date": "2025-06-25T15:10:41+01:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2025-06-25T15:10:41+01:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "joint_account_circle": "App\\Http\\Resources\\CircleResource",
        "ownership_percentage": 100,
        "previous_review_date": "2025-06-25T15:10:41+01:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2025-06-25T15:10:41+01:00"
      },
      "level_string": "Moderately Aggressive",
      "time_horizon": "For the next 5 years",
      "time_horizon_set_at": "2025-05-25T15:10:41+01:00",
      "risk_assessment_provider": "Defaqto"
    }
  ]
}