Get all sub accounts

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

Path parameters

  • plan_uuid string Required

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
    • data array[object]
      Hide data attributes Show data attributes object
      • uuid string
      • created_at string
      • updated_at string
      • name string
      • policy_number string
      • latest_valuation object
        Hide latest_valuation attributes Show latest_valuation attributes object
        • uuid string
        • created_at string
        • updated_at string
        • valued_at string
        • value object
          Hide value attributes Show value attributes object
          • amount object
            Hide amount attributes Show amount attributes object
            • example string
            • description string
          • formatted object
            Hide formatted attributes Show formatted attributes object
            • example string
            • description string
          • currency object
            Hide currency attributes Show currency attributes object
            • example string
            • description string
        • sub_account string
      • is_main_account boolean
      • active_portfolio object
        Hide active_portfolio attributes Show active_portfolio attributes object
        • uuid string
        • created_at string
        • updated_at string
        • is_proposed boolean
        • proposed_at string
        • name string
      • statistics object
        Hide statistics attribute Show statistics attribute object
        • recent_growth integer
GET /api/v1/plans/{plan_uuid}/sub-accounts 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/plans/6ff8f7f6-1eb3-3525-be4a-3932c805afed/sub-accounts' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "data": [
    {
      "name": "John's ISA",
      "uuid": "172aff23-ad82-4742-af46-cdb87350eb64",
      "created_at": "2025-06-26T11:37:07+01:00",
      "statistics": {
        "recent_growth": 100
      },
      "updated_at": "2025-06-26T11:37:07+01:00",
      "policy_number": "AVI-4837",
      "is_main_account": false,
      "active_portfolio": {
        "name": "Risky Portfolio",
        "uuid": "d116398e-4983-4b35-b514-3c7eacb3ab7e",
        "created_at": "2025-06-26T11:37:07+01:00",
        "updated_at": "2025-06-26T11:37:07+01:00",
        "is_proposed": true,
        "proposed_at": "2025-06-26T00:00:00+01:00"
      },
      "latest_valuation": {
        "uuid": "d38e125c-edfe-4c58-ac88-f0b6bcc652ca",
        "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-06-26T11:37:07+01:00",
        "created_at": "2025-06-26T11:37:07+01:00",
        "updated_at": "2025-06-26T11:37:07+01:00",
        "sub_account": "App\\Http\\Resources\\Plans\\SubAccountResource"
      }
    }
  ]
}