Get all portfolios

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

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • plan_uuid string Required
  • subAccount_uuid string Required

Query parameters

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • filter[created_at] string

    Filter portfolios when they were created.

  • filter[updated_at] string

    Filter portfolios when they were updated.

  • filter[is_proposed] boolean

    Filter portfolios that are proposed.

  • filter[proposed_at] string

    Filter portfolios when they were proposed.

  • filter[name] string

    Filter portfolios when they were created.

  • filter[exclude_active_portfolio] boolean

    Exclude the sub account's active portfolio.

  • sort string

    Field to sort by. Valid fields are [created_at, updated_at]. 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
      • is_proposed boolean
      • proposed_at string
      • name string
GET /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/portfolios 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/plans/6ff8f7f6-1eb3-3525-be4a-3932c805afed/sub-accounts/6ff8f7f6-1eb3-3525-be4a-3932c805afed/portfolios' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "name": "Risky Portfolio",
      "uuid": "ca4067ab-93b2-40c8-85da-50ef9a5d9d86",
      "created_at": "2025-06-26T11:37:08+01:00",
      "updated_at": "2025-06-26T11:37:08+01:00",
      "is_proposed": true,
      "proposed_at": "2025-06-26T00:00:00+01:00"
    }
  ]
}