Get a portfolio

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

Path parameters

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/plan_uuid/sub-accounts/subAccount_uuid/portfolios/uuid \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "name": "Risky Portfolio",
  "uuid": "449d0999-ec83-4238-85a7-cd2f6ea15cf1",
  "created_at": "2025-02-20T10:13:04+00:00",
  "updated_at": "2025-02-20T10:13:04+00:00",
  "is_proposed": true,
  "proposed_at": "2025-02-20T00:00:00+00:00"
}