Get a sub account

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

Path parameters

  • plan_uuid string Required
  • uuid string Required

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

      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

      Denotes if the sub account a main account of the plan

    • active_portfolio object

      The active portfolio of the sub account

      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

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

      Hide statistics attribute Show statistics attribute object
      • recent_growth integer
GET /api/v1/plans/{plan_uuid}/sub-accounts/{uuid} 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/plans/6ff8f7f6-1eb3-3525-be4a-3932c805afed/sub-accounts/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "name": "John's ISA",
  "uuid": "16cf86b2-bc6d-4ed4-a374-5f19db7a52ec",
  "created_at": "2025-07-28T14:57:31+01:00",
  "statistics": {
    "recent_growth": 100
  },
  "updated_at": "2025-07-28T14:57:31+01:00",
  "policy_number": "AVI-4837",
  "is_main_account": false,
  "active_portfolio": {
    "name": "Risky Portfolio",
    "uuid": "2cc45e8d-a720-4b8f-81c7-0c6c37cd437d",
    "created_at": "2025-07-28T14:57:31+01:00",
    "updated_at": "2025-07-28T14:57:31+01:00",
    "is_proposed": true,
    "proposed_at": "2025-07-28T00:00:00+01:00"
  },
  "latest_valuation": {
    "uuid": "3e6cd79a-970c-40ea-8ffc-a7ca10091925",
    "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-07-28T14:57:31+01:00",
    "created_at": "2025-07-28T14:57:31+01:00",
    "updated_at": "2025-07-28T14:57:31+01:00",
    "sub_account": "App\\Http\\Resources\\Plans\\SubAccountResource"
  }
}