Get a sub account

GET /api/v1/plans/{plan_uuid}/sub-accounts/{id}
Personal access token & OAuth2

Path parameters

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • uuid string

      UUID of the sub account

    • created_at string

      The timestamp of when the resource was created.

    • updated_at string

      The timestamp of when the resource was created.

    • name string

      Descriptive name of the sub account

    • policy_number string

      Provider reference of the sub account

    • latest_valuation object

      The latest valuation of the sub account

      Additional properties are allowed.

    • is_main_account boolean

      Denotes if the sub account a main account of the plan

    • active_portfolio object

      The active portfolio of the sub account

      Additional properties are allowed.

    • statistics object

      The statistics on a sub account. Only displayed when you retrieve an individual sub-account.

      Additional properties are allowed.
GET /api/v1/plans/{plan_uuid}/sub-accounts/{id} 
curl \
 --request GET https://api.plannrcrm.com/api/v1/plans/plan_uuid/sub-accounts/id \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json"
Response examples (200) 
{
  "name": "John's ISA",
  "uuid": "78b2e3a3-a357-4c3c-a1c4-e1a44cd00c7b",
  "created_at": "2025-02-20T10:13:04+00:00",
  "statistics": {
    "recent_growth": 100
  },
  "updated_at": "2025-02-20T10:13:04+00:00",
  "policy_number": "AVI-4837",
  "is_main_account": false,
  "active_portfolio": {
    "name": "Risky Portfolio",
    "uuid": "83b2d391-a493-436d-bd42-204af320b1f3",
    "created_at": "2025-02-20T10:13:04+00:00",
    "updated_at": "2025-02-20T10:13:04+00:00",
    "is_proposed": true,
    "proposed_at": "2025-02-20T00:00:00+00:00"
  },
  "latest_valuation": {
    "uuid": "21d50aed-9007-4884-80c8-2ab2b7edd5dd",
    "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-02-20T10:13:04+00:00",
    "created_at": "2025-02-20T10:13:04+00:00",
    "updated_at": "2025-02-20T10:13:04+00:00",
    "sub_account": "App\\Http\\Resources\\Plans\\SubAccountResource"
  }
}