Get all portfolios

GET /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/portfolios

Headers

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]

GET /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/portfolios

curl \
 -X GET https://api.plannrcrm.com/api/v1/plans/plan_uuid/sub-accounts/subAccount_uuid/portfolios \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"

Response examples (200)

{
  "data": [
    {
      "name": "Risky Portfolio",
      "uuid": "37fa97ec-882d-4c5b-983f-0a784388e1e4",
      "created_at": "2024-10-16T11:10:16+01:00",
      "updated_at": "2024-10-16T11:10:16+01:00",
      "is_proposed": true,
      "proposed_at": "2024-10-16T00:00:00+01:00"
    }
  ]
}