URL Expired

The URL for this request expired after 30 days.

pageSize

int32

The maximum number of portfolios to return. The service may return fewer than this value.

If unspecified, at most 25 portfolios will be returned.

The maximum value is 50; values above 50 will be coerced to 50.

pageToken

string

A page token received as nextPageToken in a previous List Portfolios response. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to portfolios must match the call that provided the page token.

``200 A successful response.

object

The response from the List Portfolios endpoint.

portfolios

array of objects

The retrieved portfolios.

portfolios

object

Information about a shareholder portfolio.

portfolioId

string

length between 1 and 50

The identifier of the portfolio.

legalName

string

length between 1 and 1000

The legal name of the portfolio.

createTime

date-time

Date and time when the portfolio was created.

nextPageToken

string

Submit the nextPageToken string as pageToken in a subsequent request to retrieve the next page.

If the List Portfolios response omits nextPageToken, then there are no subsequent pages.

``400 Returned if required fields are omitted or if provided fields fail validation.

``401 Returned if a valid Authorization header has not been included with the request.

``403 Returned when the user does not have permission to access the resource.

``500 Returned if an unexpected internal server error is encountered.

``default An unexpected error response.

Example API Request

curl --request GET \
     --url https://mock-api.carta.com/v1alpha1/portfolios \
     --header 'accept: application/json'

Example API Response

{
  "portfolios": [
    {
      "portfolioId": "174",
      "legalName": "Tagg Palmer's Portfolio",
      "createTime": "2017-01-12T00:00:00Z"
    }
  ],
  "nextPageToken": "ODUwMQ=="
}