portfolios

Retrieve Portfolio by ID

get/portfolios/{portfolioId}

Request

Base URL
https://api.copper.co/platform
Auth
none declared
TypeScript
https://skmtc.dev/copper-co/apis/copper-platform-api/docs/portfolios/:portfolioId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

portfolioIdstring required

Response

createdAtstring required

Portfolio creation date

createdBystring required

Portfolio creator ID

isActiveboolean required

Portfolio active state

organizationIdstring

Organization ID

portfolioDescriptionstring

Portfolio description

portfolioIdstring required

Portfolio id

portfolioNamestring required

Portfolio name

portfolioType'custody' | 'trading-vault' | 'trading' | 'external' | 'clearloop' required

statusstring

updatedAtstring

Portfolio update date

updatedBystring

Portfolio updater ID

Example response

{
  "createdAt": "1617235200000",
  "extra": {
    "exchange": "okex"
  },
  "organizationId": "1fa95ae7-5f74-4258-a4c6-687b39d7941d",
  "portfolioDescription": "My portfolio description",
  "portfolioName": "My portfolio",
  "updatedAt": "1617235200000"
}

Changes

No recorded changes to this operation across all 1 revision of this API.