Path parameters

• plan_uuid string Required
• subAccount integer Required

  Optional parameter. An optional sub-account to constrain the results by.

Query parameters

• include string

  Comma separated list of relationships to include in the response. Valid relationships are [sub_account, portfolio].

• filter[uuid] string

  Filter by a comma separated list of UUIDs.

• filter[is_active] boolean

  Filter holdings to only active or only inactive holdings. Defaults to true.

• filter[portfolio_uuid] string

  Filter holdings by a given portfolio_uuid. Defaults to showing holdings from the active portfolio or all holdings.

• sort string

  Field to sort by. Valid fields are [created_at, updated_at, units, unit_price, is_active]. Negative sign to denote DESC. Defaults to '-created_at'.

• 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
    • fund_name string
    • reference string
    • sector string
    • sedol string
    • isin string
    • citi string
    • units integer
    • unit_price object
      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
    • purchase_price object
      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
    • 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 object
      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
      Hide external_references attributes Show external_references attributes object

      • uuid string
      • created_at string
      • updated_at string
      • third_party string
      • reference string