Get all holdings Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://apidocs.plannrcrm.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
"PlannrCRM MCP server": {
  "url": "https://apidocs.plannrcrm.com/mcp"
}
Close
GET /api/v1/plans/{plan_uuid}/holdings/{subAccount}

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
GET /api/v1/plans/{plan_uuid}/holdings/{subAccount}
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/plans/6ff8f7f6-1eb3-3525-be4a-3932c805afed/holdings/{"summary" => "When the value is omitted", "value" => ""}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "data": [
    [
      {
        "uuid": "397bd86a-2011-42ee-a5cd-ad137d3d5d6c",
        "created_at": "2026-06-09T14:10:14+01:00",
        "updated_at": "2026-06-09T14:10:14+01:00",
        "fund_name": "Fund",
        "reference": "REF123",
        "sector": "Europe",
        "sedol": "ACB123",
        "isin": "ACB123",
        "citi": "ACB123",
        "units": 5,
        "unit_price": {
          "amount": {
            "example": "1000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "formatted": {
            "example": "£10.00",
            "description": "Money amount formatted with currency"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          }
        },
        "unit_price_raw": 10,
        "purchase_price": {
          "amount": {
            "example": "4000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "formatted": {
            "example": "£40.00",
            "description": "Money amount formatted with currency"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          }
        },
        "is_active": true,
        "value": {
          "amount": {
            "example": "4000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "formatted": {
            "example": "£40.00",
            "description": "Money amount formatted with currency"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          }
        },
        "sub_account": {
          "uuid": "9e5a1ff3-a423-4959-afff-d3f27bbcbfc2",
          "created_at": "2026-06-09T14:10:14+01:00",
          "updated_at": "2026-06-09T14:10:14+01:00",
          "name": "John's ISA",
          "policy_number": "AVI-4837",
          "latest_valuation": "App\\Http\\Resources\\Plans\\ValuationResource",
          "is_main_account": false,
          "active_portfolio": "App\\Http\\Resources\\Plans\\PortfolioResource",
          "statistics": {
            "recent_growth": 100
          }
        },
        "external_references": {
          "uuid": "c873f8ad-2868-4aee-abab-238181115d8e",
          "created_at": "2026-06-09T14:10:14+01:00",
          "updated_at": "2026-06-09T14:10:14+01:00",
          "third_party": "nucleus",
          "reference": "AB123456"
        }
      }
    ]
  ]
}