Headers
-
Content-Type string
-
Accept string
-
X-PLANNR-ACCOUNT-UUID string
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).
GET /api/v1/client/{client_uuid}/risk
curl \
-X GET https://api.plannrcrm.com/api/v1/client/client_uuid/risk \
-H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
"data": [
{
"uuid": "bfd4e0dd-e9d3-4312-a890-ad0ad8aea1a9",
"level": 52,
"created_at": "2024-10-16T11:10:13+01:00",
"updated_at": "2024-10-16T11:10:13+01:00",
"completed_at": "2023-10-16T11:10:13+01:00",
"completed_by": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "eeeda283-9c8c-4d65-b09f-1509786d6b8a",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2024-10-16T11:10:13+01:00",
"first_name": "Gareth",
"updated_at": "2024-10-16T11:10:13+01:00",
"with_login": true,
"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": "2024-10-16T11:10:13+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2024-10-16T11:10:13+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"previous_review_date": "2024-10-16T11:10:13+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2024-10-16T11:10:13+01:00"
},
"level_string": "Moderately Aggressive",
"time_horizon": "For the next 5 years",
"time_horizon_set_at": "2024-09-16T11:10:13+01:00",
"risk_assessment_provider": "Defaqto"
}
]
}