Get all sub accounts
Headers
-
Content-Type string
-
Accept string
Query parameters
-
include string
Comma separated list of relationships to include in the response. Valid relationships are [latest_valuation].
-
filter[uuid] string
Filter by a comma separated list of UUIDs.
-
sort string
Field to sort by. Valid fields are [created_at, name]. Negative sign to denote DESC. Defaults to 'name'.
-
per_page integer
Number of results to return with pagination (Default 15. Max 500).
GET /api/v1/plans/{plan_uuid}/sub-accounts
curl \
-X GET https://api.plannrcrm.com/api/v1/plans/plan_uuid/sub-accounts \
-H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
Response examples (200)
{
"data": [
{
"name": "John's ISA",
"uuid": "ef39525e-b600-4fe8-8dc8-50cbd167cbc4",
"created_at": "2024-10-16T11:10:15+01:00",
"statistics": {
"recent_growth": 100
},
"updated_at": "2024-10-16T11:10:15+01:00",
"policy_number": "AVI-4837",
"is_main_account": false,
"active_portfolio": {
"name": "Risky Portfolio",
"uuid": "3cd6ed06-d81c-48d8-8e5f-f5ac9a7608f5",
"created_at": "2024-10-16T11:10:15+01:00",
"updated_at": "2024-10-16T11:10:15+01:00",
"is_proposed": true,
"proposed_at": "2024-10-16T00:00:00+01:00"
},
"latest_valuation": {
"uuid": "b3868e27-85f6-4e18-8a4a-3af10fdd4469",
"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"
}
},
"valued_at": "2024-10-16T11:10:15+01:00",
"created_at": "2024-10-16T11:10:15+01:00",
"updated_at": "2024-10-16T11:10:15+01:00",
"sub_account": "App\\Http\\Resources\\Plans\\SubAccountResource"
}
}
]
}