List Share Classes
| Time | Status | User Agent | |
|---|---|---|---|
| Make a request to see history. |
URL Expired
The URL for this request expired after 30 days.
Share Class Retrieval Parameters
- issuerId: The identifier of the issuer that has issued the share classes to retrieve.
- asOfDate: Retrieve share classes as of the given date. Expected format for this date is ISO 8601 complete calendar date; i.e., 'YYYY-MM-DD'
- pageSize: The maximum number of share classes to return. The service may return fewer than this value; if unspecified, at most 25 share classes will be returned. The maximum value is 50; values above 50 will be coerced to 50.
- pageToken: A page token received as
nextPageTokenin a previous List Share Classes response. Provide this to retrieve the subsequent page.
Response Schema
```200 A successful response.
object
The response for the ListShareClasses endpoint.
shareClasses: array of objects
shareClasses: object
- id: string (length between 1 and 50) - The identifier of the share class.
- issuerId: string (length between 1 and 50) - The identifier of the issuer to which this share class belongs.
- name: string (length ≤ 100) - The name of the share class.
- prefix: string (length between 1 and 25) - The prefix used to identify the share class. For example, CS for Common, PS for Series Seed Preferred, and PA for Series A Preferred.
- type: string (enum) - The type of the share class.
- authorizedShareCount: object - The maximum number of shares allowed to be issued to investors, as laid out in the articles of incorporation.
- parValue: object - The minimum price per share at which the shares must be issued.
- seniority: int32 - Indicates the order in which shareholders will get paid.
- pariPassu: boolean - Indicates whether this share class has equal seniority to an existing share class.
- preferredShareClassDetails: object - Preferred share class details when share class type is set to preferred.
nextPageToken: string - Submit the
nextPageTokenstring aspageTokenin a subsequent request to retrieve the next page.
```
Error Codes
- 400: Returned if required fields are omitted or if provided fields fail validation.
- 401: Returned if a valid
Authorizationheader 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 Request
curl --request GET \
--url https://mock-api.carta.com/v1alpha1/issuers/{issuerId}/shareClasses \
--header 'accept: application/json'
Example Response
{
"shareClasses": [
{
"id": "783",
"issuerId": "7",
"name": "SeriesB",
"prefix": "PSB",
"type": "PREFERRED",
"authorizedShareCount": { "value": "0" },
"parValue": { "currencyCode": { "value": "USD" }, "amount": { "value": "0.0001" } },
"seniority": 1,
"pariPassu": true,
"preferredShareClassDetails": {
"rightsAndPreferences": {
"originalIssuePrice": { "currencyCode": { "value": "USD" }, "amount": { "value": "1.77" } },
"conversionPrice": { "currencyCode": { "value": "USD" }, "amount": { "value": "1.50" } },
"conversionRatio": { "value": "0.789" },
"multiplier": { "value": "1.00" },
"participating": true,
"participationCap": { "value": "1.00" }
},
"dividendDetails": {
"dividendType": "CASH",
"dividendDetails": {
"dividendYield": { "value": "0.02" },
"dividendAccrualType": "CUMULATIVE",
"dividendAccrualPeriod": "DAILY",
"dividendInterestType": "INTEREST_PERIOD_DAILY"
}
}
}
}
],
"nextPageToken": "NDY="
}
Updated about 2 months ago.