Skip to main content
GET
/
portfolios
/
{portfolioId}
Retrieve Portfolio by ID
curl --request GET \
  --url https://api.copper.co/platform/portfolios/{portfolioId}
{
  "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>"
}

Path Parameters

portfolioId
string
required

Response

OK

createdAt
string
required

Portfolio creation date

Example:

"1617235200000"

createdBy
string
required

Portfolio creator ID

isActive
boolean
required

Portfolio active state

portfolioId
string
required

Portfolio id

portfolioName
string
required

Portfolio name

Example:

"My portfolio"

portfolioType
enum<string>
required

Portfolio type. See details

Available options:
custody,
trading-vault,
trading,
external,
clearloop
Example:

"custody"

extra
object

Portfolio extra data

organizationId
string

Organization ID

Example:

"1fa95ae7-5f74-4258-a4c6-687b39d7941d"

portfolioDescription
string

Portfolio description

Example:

"My portfolio description"

status
enum<string>

Portfolio status

Example:

"active"

updatedAt
string

Portfolio update date

Example:

"1617235200000"

updatedBy
string

Portfolio updater ID