portfolios

Get Portfolio

get/v1/portfolios/{portfolio_id}

Request

Base URL
https://api.knownwell.com (the document declares no server; this is the origin it was published from)
Auth
API key in header X-API-Key
TypeScript
https://skmtc.dev/knownwell/apis/knownwell-api/docs/v1/portfolios/:portfolio_id/get.ts
A function with typed inputs. Its response is checked against the schema.

portfolio_idstring required

include_clientsboolean

limitinteger

offsetinteger

Members to skip. clientCount is the unpaginated total, so page until you have collected that many.

Successful Response

idstring required

namestring required

colorstring nullable

descriptionstring nullable

customerIdstring required

clientCountinteger required

Number of clients in portfolio

userIdsstring[] nullable

User IDs with access

isSystemboolean

Whether this is a system portfolio

createdAtstring date-time nullable

updatedAtstring date-time nullable