Skip to main content
GET
/
clearloop
/
portfolios
/
{portfolioId}
Get ClearLoop Portfolio by Id
curl --request GET \
  --url https://api.copper.co/platform/clearloop/portfolios/{portfolioId}
{
  "delegationsEnabled": true,
  "disabledDelegationsReason": "<string>",
  "disabledUndelegationsReason": "<string>",
  "organizationId": "<string>",
  "portfolioId": "<string>",
  "settlementDetails": {
    "comments": "<string>",
    "status": "not-yet-settled"
  },
  "undelegationsEnabled": true
}

Path Parameters

​
portfolioId
string
required

Response

OK

​
delegationsEnabled
boolean

Indicates whether delegations are enabled for the ClearLoop portfolio

​
disabledDelegationsReason
string

Reason why delegations are disabled for the ClearLoop portfolio. Example: CL-SETTLEMENTS-1, which means that delegation is disabled due to an upcoming or pending settlement

​
disabledUndelegationsReason
string

Reason why undelegations are disabled for the ClearLoop portfolio. Example: CL-SETTLEMENTS-1, which means that undelegation is disabled due to an upcoming or pending settlement

​
organizationId
string

Identifier of the client organisation holding the ClearLoop portfolio

​
portfolioId
string

Identifier of the ClearLoop portfolio

​
settlementDetails
object

Settlement details associated with the ClearLoop portfolio

​
undelegationsEnabled
boolean

Indicates whether undelegations are enabled for the ClearLoop portfolio