Get all client cases
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 [participants, participants_count, status, tags, plans, custom_fields].
-
filter[uuid] string
Filter by a comma separated list of UUIDs.
-
filter[completed] boolean
Filter cases by which have been completed
-
filter[in_progress] boolean
Filter cases by which are still in progress
-
filter[type] string
Comma separated string of types to filter by
-
filter[status] string
Comma separated string of statuses to filter by
-
filter[plan_uuid] string
Comma separated string of plan UUIDs to filter by.
-
per_page integer
Number of results to return with pagination (Default 15. Max 500).
-
sort string
Field to sort by. Valid fields are [created_at, name, status_position, value, completed_at]. Negative sign to denote DESC. Defaults to 'name'.
GET /api/v1/client/{client_uuid}/cases
curl \
-X GET https://api.plannrcrm.com/api/v1/client/client_uuid/cases \
-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": [
{
"name": "finance",
"slug": "finance",
"type": {
"name": "Mortgage Plan",
"uuid": "5be70de9-f698-46a0-bca2-b63cc016f377",
"created_at": "2024-10-16T11:10:13+01:00",
"updated_at": "2024-10-16T11:10:13+01:00"
},
"uuid": "47e8a127-40c1-4a7a-b080-332550eb071f",
"plans": {
"name": "Johns ISA",
"tags": "App\\Http\\Resources\\TagResource",
"type": "cash_account",
"uuid": "24285443-f8de-40d7-a32a-6d24ba032db3",
"wrap": "App\\Http\\Resources\\Plans\\PlanResource",
"cases": "App\\Http\\Resources\\CasesResource",
"value": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
}
},
"claims": "App\\Http\\Resources\\Plans\\ClaimResource",
"client": "App\\Http\\Resources\\AccountResource",
"covers": "App\\Http\\Resources\\Plans\\CoverResource",
"seller": "App\\Http\\Resources\\AccountResource",
"status": "inactive",
"on_panel": true,
"provider": "App\\Http\\Resources\\Plans\\ProviderResource",
"sub_type": "lifetime isa",
"opened_at": "2024-10-16T11:10:13+01:00",
"valued_at": "2024-10-16T11:10:13+01:00",
"created_at": "2024-10-16T11:10:13+01:00",
"statistics": {
"recent_growth": 100
},
"updated_at": "2024-10-16T11:10:13+01:00",
"advice_area": "non_investment_insurance",
"inactive_at": "2024-10-16T11:10:13+01:00",
"review_date": "2023-10-16",
"linked_plans": "App\\Http\\Resources\\Plans\\PlanResource",
"main_account": "App\\Http\\Resources\\Plans\\SubAccountResource",
"sub_accounts": "App\\Http\\Resources\\Plans\\SubAccountResource",
"under_advice": true,
"abstract_type": "asset",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"is_wrap_child": false,
"linked_owners": "App\\Http\\Resources\\AccountResource",
"policy_number": "AVIVA-123",
"show_on_joint": true,
"wrap_children": "App\\Http\\Resources\\Plans\\PlanResource",
"can_be_deleted": "false",
"total_benefits": {
"critical_illness": {
"amount": {
"example": "15000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£150,000.00",
"description": "Money amount formatted with currency"
}
},
"family_income_benefit": {
"amount": {
"example": "10000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£100,000.00",
"description": "Money amount formatted with currency"
}
}
},
"inactive_reason": "claimed",
"is_group_scheme": false,
"is_wrap_product": false,
"latest_valuations": "App\\Http\\Resources\\Plans\\ValuationResource",
"proposal_reference": "AB123456",
"agency_in_your_name": true,
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"is_sub_group_scheme": false,
"total_benefit_amount": {
"amount": {
"example": "25000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£250,000.00",
"description": "Money amount formatted with currency"
}
},
"is_group_scheme_member": false,
"originally_sold_by_firm": true,
"agency_in_your_name_from": "2023-10-16",
"contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
"visible_on_client_portal": true,
"include_in_client_valuation": true
},
"value": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
}
},
"status": {
"name": "To Be Reviewed",
"uuid": "121c0d27-1f01-4dc8-9843-4285d60356c8",
"colour": "#23852B",
"position": 5,
"created_at": "2024-10-16T11:10:13+01:00",
"updated_at": "2024-10-16T11:10:13+01:00"
},
"created_at": "2024-10-16T11:10:13+01:00",
"updated_at": "2024-10-16T11:10:13+01:00",
"completed_at": "2024-10-16T11:10:13+01:00",
"participants": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "7f048dca-8dcb-4ed5-9ad5-714da5aa50a9",
"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"
},
"custom_fields": [
{
"name": "Favourite Drink",
"type": "string",
"uuid": "01e10e84-633c-47e4-840f-3ee993d59c92",
"value": "Coffee",
"help_text": "This is the client's favourite drink.",
"reference": "favourite_drink",
"created_at": "2024-10-16T11:10:13+01:00",
"updated_at": "2024-10-16T11:10:13+01:00",
"is_required": false,
"selection_options": [
"Coffee",
"Tea",
"Water"
]
}
],
"status_position": 4,
"task_board_uuid": "a4238892-97cc-4ea8-85ec-ab4ab4287bde",
"participants_count": 4
}
]
}