List Vesting Schedule Templates

Time	Status	User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

API Parameters

issuerId (string, required): The identifier of the issuer that has issued the share classes to retrieve.
pageSize (int32): The maximum number of vesting schedule templates to return. The service may return fewer than this value. If unspecified, at most 25 vesting schedule templates 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 Vesting Schedule Templates response. Provide this to retrieve the subsequent page. When paginating, all other parameters must be kept consistent with those used in the request where the page token was obtained.

``200 A successful response.

object: The response for the ListVestingScheduleTemplates endpoint.
vestingScheduleTemplates (array of objects): A list of vesting schedule templates.
- vestingScheduleTemplates (object): Details of a vesting schedule template.
  - id (string, length ≤ 50): The identifier of the vesting schedule template.
  - issuerId (string, length ≤ 50): The identifier of the issuer to which this vesting schedule template belongs.
  - name (string, length ≤ 500): The name of the vesting schedule template.
  - description (string, length ≤ 1000): The description of the vesting schedule template.
  - vestingScheduleType (string, enum): The type of vesting schedule found within this template.
  - uuid (string, length between 36 and 36): The UUID of the vesting schedule template.
  - periods (array of objects): The vesting periods that define how shares vest.
    - periods (object): A vesting period defines a portion of shares that vest.
      - order (int32): The order of this period in the vesting schedule.
      - percentage (object): The percentage of shares that vest in this period.
        
        vestingMethod (string, enum): The frequency at which shares vest.
        
        vestingOccurs (string, enum): When vesting occurs within each period.
      - length (int32): The duration of the vesting period.
      - lengthUnit (string, enum): The unit of the duration (days, months, years).
      - immediatePercentage (object): The percentage of shares that vest immediately on the vesting start date.
      - cliffPercentage (object): The percentage of shares that vest at the cliff.
      - cliffLength (int32): The duration until the cliff.
      - cliffLengthUnit (string, enum): The unit of the cliff duration.
      - milestoneName (string, length ≤ 500): The name of the milestone for milestone-based periods.
      - performanceCondition (object): The performance condition associated with this period.

Pagination

nextPageToken (string): Submit the nextPageToken string as pageToken in a subsequent request to retrieve the next page. If the List Vesting Schedule Templates response omits nextPageToken, then there are no subsequent pages.

Error Responses

``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 of a Successful Response

{
  "vestingScheduleTemplates": [
    {
      "id": "1",
      "uuid": "550e8400-e29b-41d4-a716-446655440000",
      "issuerId": "7",
      "name": "1/24, No Cliff",
      "description": "Shares vest monthly for the next 24 months on the same day as the start date.",
      "vestingScheduleType": "DATE",
      "periods": [
        {
          "order": 1,
          "percentage": "100",
          "vestingMethod": "MONTHLY",
          "vestingOccurs": "SAME_DAY_AS_START_DATE",
          "length": 24,
          "lengthUnit": "MONTH"
        }
      ]
    }
  ],
  "nextPageToken": "ODMxMw=="
}

Example of a cURL Request

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