Get a portfolio

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

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

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 updated.
- is_proposed boolean
  
  Denotes if the portfolio is proposed
- proposed_at string
  
  The date the portfolio was proposed.
- name string
  
  The name of the portfolio.

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

curl \
 --request GET 'https://api.plannrcrm.com/api/v1/plans/6ff8f7f6-1eb3-3525-be4a-3932c805afed/sub-accounts/6ff8f7f6-1eb3-3525-be4a-3932c805afed/portfolios/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"

Response examples (200)

{
  "name": "Risky Portfolio",
  "uuid": "29c1e0dc-d74e-4e1d-a26e-1d17aade6698",
  "created_at": "2025-08-27T17:31:27+01:00",
  "updated_at": "2025-08-27T17:31:27+01:00",
  "is_proposed": true,
  "proposed_at": "2025-08-27T00:00:00+01:00"
}