List Portfolio Issuers
| Time | Status | User Agent | |
|---|---|---|---|
| Make a request to see history. |
URL Expired
The URL for this request expired after 30 days.
portfolioId
string
required
The identifier of the portfolio whose issuers are to be retrieved.
pageSize
int32
The maximum number of issuers to return. The service may return fewer than this value.
If unspecified, at most 25 issuers 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 Portfolio Issuers response. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to issuers must match the call that provided the page token.
``200 A successful response.
object
The response from the List Portfolio Issuers endpoint.
issuers
array of objects
The retrieved issuers.
issuers
object
Information about an issuer.
id
string
length ≤ 50
The identifier of the issuer.
legalName
string
length ≤ 1000
The legal name of the issuer.
doingBusinessAsName
string
length ≤ 1000
The operating name of the issuer.
website
string
length ≤ 1000
The URL of the issuer’s website, if available.
nextPageToken
string
Submit the nextPageToken string as pageToken in a subsequent request to retrieve the next page.
If the List Portfolio Issuers response omits nextPageToken, then there are no subsequent pages.
issuersRedacted
boolean
Indicates if issuers have been filtered out of the response.
``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.
Base URL
https://mock-api.carta.com/v1alpha1/portfolios/{portfolioId}/issuers
xxxxxxxxxx
curl --request GET \
--url https://mock-api.carta.com/v1alpha1/portfolios/portfolioId/issuers \
--header 'accept: application/json'
xxxxxxxxxx
{
"issuers": [
{
"id": "611",
"legalName": "MangoCart, Inc.",
"doingBusinessAsName": "MangoCart",
"website": "http://www.example.com/mangocart"
}
],
"nextPageToken": "NDY=",
"issuersRedacted": true
}