Get a holding

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

Path parameters

  • plan_uuid string Required
  • subAccount_uuid string Required
  • uuid string Required

Responses

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

      The UUID of the resource.

    • created_at string

      The timestamp of when the resource was created.

    • updated_at string

      The timestamp of when the resource was created.

    • fund_name string

      The name of the fund.

    • reference string

      The reference of the holding.

    • sector string

      The sector of the holding.

    • sedol string

      The SEDOL of the holding.

    • isin string

      The ISIN of the holding.

    • citi string

      The CITI of the holding.

    • units integer

      Holding units as a decimal.

    • unit_price object

      The unit price of the holding.

      Hide unit_price attributes Show unit_price 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
    • unit_price_raw integer

      The raw unit price of the holding.

    • purchase_price object

      The purchase price of the holding.

      Hide purchase_price attributes Show purchase_price 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
    • is_active boolean

      Denotes if the holding is active or not.

    • value object

      The current value of the holding.

      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 object

      The holdings sub account.

      Hide sub_account attributes Show sub_account attributes object
      • uuid string
      • created_at string
      • updated_at string
      • name string
      • policy_number string
      • latest_valuation string
      • is_main_account boolean
      • active_portfolio string
      • statistics object
        Hide statistics attribute Show statistics attribute object
        • recent_growth integer
    • external_references object

      The external references of the holding.

      Hide external_references attributes Show external_references attributes object
      • uuid string
      • created_at string
      • updated_at string
      • third_party string
      • reference string
GET /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/holdings/{uuid} 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/plans/6ff8f7f6-1eb3-3525-be4a-3932c805afed/sub-accounts/6ff8f7f6-1eb3-3525-be4a-3932c805afed/holdings/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "citi": "ACB123",
  "isin": "ACB123",
  "uuid": "b73e4197-5e94-4281-adec-fceeb7e4a4f4",
  "sedol": "ACB123",
  "units": 5,
  "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"
    }
  },
  "sector": "Europe",
  "fund_name": "Fund",
  "is_active": true,
  "reference": "REF123",
  "created_at": "2025-09-17T15:46:53+01:00",
  "unit_price": {
    "amount": {
      "example": "1000",
      "description": "Money amount at their lowest denominator (for example: pennies)"
    },
    "currency": {
      "example": "GBP",
      "description": "Currency of the money"
    },
    "formatted": {
      "example": "£10.00",
      "description": "Money amount formatted with currency"
    }
  },
  "updated_at": "2025-09-17T15:46:53+01:00",
  "sub_account": {
    "name": "John's ISA",
    "uuid": "94528147-f469-41c7-8add-83e78051e3b0",
    "created_at": "2025-09-17T15:46:53+01:00",
    "statistics": {
      "recent_growth": 100
    },
    "updated_at": "2025-09-17T15:46:53+01:00",
    "policy_number": "AVI-4837",
    "is_main_account": false,
    "active_portfolio": "App\\Http\\Resources\\Plans\\PortfolioResource",
    "latest_valuation": "App\\Http\\Resources\\Plans\\ValuationResource"
  },
  "purchase_price": {
    "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"
    }
  },
  "unit_price_raw": 10,
  "external_references": {
    "uuid": "4446fe9a-df1d-44b4-85da-da8528e73589",
    "reference": "AB123456",
    "created_at": "2025-09-17T15:46:53+01:00",
    "updated_at": "2025-09-17T15:46:53+01:00",
    "third_party": "nucleus"
  }
}