Get all sub accounts

GET /api/v1/plans/{plan_uuid}/sub-accounts
Personal access token & O auth2

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).

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
GET /api/v1/plans/{plan_uuid}/sub-accounts 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/plans/plan_uuid/sub-accounts' \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json"
Response examples (200) 
{
  "data": [
    {
      "name": "John's ISA",
      "uuid": "103c4b6d-e6a0-439d-a0f6-5528fb35cb44",
      "created_at": "2025-04-02T13:27:57+01:00",
      "statistics": {
        "recent_growth": 100
      },
      "updated_at": "2025-04-02T13:27:57+01:00",
      "policy_number": "AVI-4837",
      "is_main_account": false,
      "active_portfolio": {
        "name": "Risky Portfolio",
        "uuid": "aafdb19f-9226-4654-bf84-c207feb5d264",
        "created_at": "2025-04-02T13:27:57+01:00",
        "updated_at": "2025-04-02T13:27:57+01:00",
        "is_proposed": true,
        "proposed_at": "2025-04-02T00:00:00+01:00"
      },
      "latest_valuation": {
        "uuid": "8f5e2f9a-223b-4786-82d2-3d07269d941a",
        "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": "2025-04-02T13:27:57+01:00",
        "created_at": "2025-04-02T13:27:57+01:00",
        "updated_at": "2025-04-02T13:27:57+01:00",
        "sub_account": "App\\Http\\Resources\\Plans\\SubAccountResource"
      }
    }
  ]
}