List equity portfolios

get

https://api.secondengine.com/{tenant}/portfolio/equity

List US/Canadian Equity portfolios.

Query Params

searchTerm

string

A search term to filter the results. Optional parameter.

modelType

string

enum

What type of model is this (ALL if none provided)

Allowed:

onlyFullyAllocated

boolean

Defaults to false

Return only fully allocated portfolios that can be added to a compare

onlySaved

boolean

Defaults to false

Return only saved portfolios (no drafts)

onlyMine

boolean

Defaults to false

Only return portfolios that are owned by the user logged in as the owner

portfolioIdToIgnore

uuid

Ignore this Portfolio ID when checking for duplicate names, can be used for updates

portfolioType

string

enum

The type of the portfolio to be selected

Allowed:

forUser

uuid

Defaults to null

Only return portfolios that belong to this person

sortableFields

array of strings

Fields that should be sorted by, will be taken in order provided, (defaults to Sort Order and Updated At)

sortableFields

sortDirections

array of strings

Sort direction, (Defaults to ascending (ASC) sort)

sortDirections

limit

number

1 to 50

Defaults to 20

The number of items to return. Default is 20. Max is 50.

page

number

≥ 1

Defaults to 1

The page number to return. Default is 1.

Response

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The list of Equity portfolios with the specified filters and pagination