Skip to main content
GET
/
portfolios
Get Portfolios
curl --request GET \
  --url https://api.copper.co/platform/portfolios
{
  "portfolios": [
    {
      "createdAt": "<string>",
      "createdBy": "<string>",
      "isActive": true,
      "portfolioId": "<string>",
      "portfolioName": "<string>",
      "portfolioType": "custody",
      "extra": {
        "baseCurrency": "<string>",
        "clearLoopDelegationsBlocked": true,
        "clearLoopPortfolioId": "<string>",
        "clearLoopUnDelegationsBlocked": true,
        "clientAccountId": "<string>",
        "customerId": "<string>",
        "exchange": "<string>",
        "externalAccountId": "<string>",
        "parentPortfolioId": "<string>",
        "quoteCurrency": "<string>",
        "showWalletBalance": "real",
        "usdWithdrawalLimit": "<string>"
      },
      "organizationId": "<string>",
      "portfolioDescription": "<string>",
      "updatedAt": "<string>",
      "updatedBy": "<string>"
    }
  ]
}

Query Parameters

​
portfolioTypes
enum<string>[]

Filter by portfolio types. See details

Available options:
custody,
trading-vault,
trading,
external,
clearloop
​
excludedPortfolioTypes
enum<string>[]

Filter by portfolio types not in. See details

Available options:
custody,
trading-vault,
trading,
external,
clearloop
​
portfolioId
string

Filter by portfolio id

​
organizationId
string

Filter by organization id

​
isActive
boolean
default:true

Filter by is active

​
isDefiVault
boolean

Filter only DeFi vaults

​
signingFlowType
enum<string>

Filter by signing enabled signing flow type

​
offset
string

Offset for pagination

​
limit
string

Limit for pagination

Response

OK

​
portfolios
object[]
required

List of portfolios