List Restricted Stock Units

Time	Status	User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

issuerId

string

required

The identifier of the issuer owning the restricted stock units to retrieve.

pageSize

int32

The maximum number of restricted stock units to return. The service may return fewer than this value.

If unspecified, at most 25 funds 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 Restricted Stock Units response. Provide this to retrieve the subsequent page.

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

lastModifiedDatetimeAfter

string

Return restricted stock units that were last modified on or after this date and time. Uses UTC and is specified in ISO 8601 format, i.e. 'YYYY-MM-DDThh:mm:ssZ'.

lastModifiedDatetimeBefore

string

Return restricted stock units that were last modified on or before this date and time. Uses UTC and is specified in ISO 8601 format, i.e. 'YYYY-MM-DDThh:mm:ssZ'.

``200 A successful response.

object

The response from the List Restricted Stock Units endpoint.

restrictedStockUnits

array of objects

The restricted stock units from the specified issuer.

restrictedStockUnits

object

A restricted stock unit is a grant of company shares.

string

length between 1 and 50

The identifier of the restricted stock unit.

securityId

string

length ≤ 50

The UUID of the restricted stock unit. Use this to cross-reference with the List Transactions API.

shareClassId

string

length ≤ 50

The UUID of the share class for this restricted stock unit. May be absent if there is no associated share class.

vestingScheduleTemplateId

string

length ≤ 50

The UUID of the vesting schedule template used by this restricted stock unit. May be absent if the unit has no vesting schedule.

issuerId

string

length between 1 and 50

The identifier of the issuer owning the restricted stock unit.

stakeholderId

string

length ≤ 50

The identifier of the stakeholder that received the restricted stock unit.

equityIncentivePlanName

string

length ≤ 100

The name of the equity incentive plan (i.e., option plan) associated with the restricted stock unit.

issueDate

object

The date the restricted stock unit was issued.

issueDate object

vestingStartDate

object

The start date of the vesting period for the restricted stock unit, specified as an ISO 8601 extended format calendar date, i.e. 'YYYY-MM-DD'.

vestingStartDate object

boardApprovalDate

object

The date the restricted stock unit received board approval.

boardApprovalDate object

stakeholderAcceptanceDate

object

The date the restricted stock unit was accepted by the stakeholder, specified as an ISO 8601 extended format calendar date, i.e. 'YYYY-MM-DD'.

stakeholderAcceptanceDate object

quantity

object

The total quantity of shares in the restricted stock unit grant.

quantity object

vestedQuantity

object

The total quantity of restricted stock units in the grant that have been vested.

vestedQuantity object

releasedQuantity

object

The total quantity of restricted stock units in the grant that have been settled.

releasedQuantity object

releasePricePerShare

object

The price of each share that has been released from the restricted stock unit grant.

releasePricePerShare object

netSettledQuantity

object

The total quantity of restricted stock units in this grant that have been released to the stakeholder.

netSettledQuantity object

securityLabel

string

length ≤ 50

The label representing this security (restricted stock unit).

vestingEvents

array of objects

The list of all vesting events associated with these restricted stock units.

vestingEvents

object

Restricted stock unit vesting event information.

string

length ≤ 50

The identifier of the restricted stock unit vesting event.

vestDate

object

The date of the vesting event. For milestone-based vesting events, vestDate will be omitted until the security has vested.

vestDate object

quantity

object

The number of shares being vested in this vesting event by this event’s date.

Deprecated: use maxQuantity, targetQuantity, vestedQuantity fields instead.

For vesting events from strictly time-based vesting schedules, this field will be the amount of shares vesting in the tranche represented by this vesting event, regardless of whether the tranche has actually vested.

For vesting events with performance conditions, this field will be set to either:

if the performance condition has not been achieved, the maximum quantity of shares that could be vested
if the performance condition has been achieved, the target quantity of shares that are vested based on the payout details of the performance condition

The number of shares being vested in this vesting event by this event’s date. Deprecated. object

performanceCondition

boolean

Indicates that this vesting event has associated performance or milestone vesting conditions.

performanceCondition will be true for milestone- and performance-based vesting events.

For performance-based vesting events, performanceCondition indicates that a performance condition exists, not that it has been met.

vested

boolean

Indicates that this vesting event has vested.

maxQuantity

object

The maximum number of shares vested in this vesting event.

For vesting events with performance conditions, this value will be based on the maximum payout defined within the performance condition.

For regular time-based vesting events, this value will be equivalent to the target_payout field.

The maximum number of shares vested in this vesting event. object

targetQuantity

object

The target number of shares vested in this vesting event.

The target number of shares reflects the number of shares that have vested or should vest within the vesting event independent of any performance condition payout details.

If this vesting event has no performance condition, then this value will reflect the value that is or will be in the vestedQuantity field.

The target number of shares vested in this vesting event. object

vestedQuantity

object

The actual number of shares vested in this vesting event.

This value will only be set if the vesting event is actually vested (i.e., the vested field is true). Otherwise, if the vesting event is unvested, then this value will be unset.

The actual number of shares vested in this vesting event. object

canceledDate

object

The date the restricted stock unit was canceled.

canceledDate object

terminationDate

object

The date the restricted stock unit was terminated.

terminationDate object

settlements

array of objects

The list of all settlements associated with these restricted stock units.

settlements

object

Restricted stock unit settlement information.

settlementDate

object

The date of the settlement.

settlementDate object

releaseQuantity

object

The quantity released during the settlement.

releaseQuantity object

saleQuantity

object

The quantity sold in a cashless transaction to cover the cost of the settlement.

saleQuantity object

withholdingQuantity

object

The quantity withheld during the settlement.

withholdingQuantity object

netSettlementQuantity

object

The net quantity settled after quantities are sold or withheld.

netSettlementQuantity object

settlementPrice

object

The price to settle one unit of the RSU.

settlementPrice object

certificateId

string

length between 1 and 1000

The resource identifier for the certificate that was generated as part of the transaction.

certificateLabel

string

The label of the certificate that was generated as part of the transaction (e.g. CS-107).

vestingSchedule

object

The vesting schedule information associated with the restricted stock unit.

vestingSchedule object

canceledQuantity

object

The number of shares in the restricted stock unit that were canceled.

canceledQuantity object

forfeitedQuantity

object

The number of shares in the restricted stock unit that were forfeited.

forfeitedQuantity object

expiredQuantity

object

The number of shares in the restricted stock unit that expired.

expiredQuantity object

returnedToPoolQuantity

object

The number of shares in the restricted stock unit that were returned to the pool.

returnedToPoolQuantity object

returnedToTreasuryQuantity

object

The number of shares in the restricted stock unit that were annulled, but not returned to the pool.

returnedToTreasuryQuantity object

lastModifiedDatetime

object

The date and time when the restricted stock unit was last modified.

lastModifiedDatetime object

nextPageToken

string

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

If the 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.

Updatedabout 2 months ago

Did this page help you?

Yes

ShellNodeRubyPHPPython

Bearer

Base URL

https://mock-api.carta.com/v1alpha1/issuers/{issuerId}/restrictedStockUnits


xxxxxxxxxx

curl --request GET \

--url https://mock-api.carta.com/v1alpha1/issuers/issuerId/restrictedStockUnits \

--header 'accept: application/json'


xxxxxxxxxx

{

"restrictedStockUnits": [\
\
    {\
\
      "id": "8550",\
\
      "securityId": "e5f6a7b8-c9d0-1234-efab-345678901234",\
\
      "shareClassId": "f2a3b4c5-d6e7-8901-fabc-012345678901",\
\
      "vestingScheduleTemplateId": "a3b4c5d6-e7f8-9012-abcd-123456789abc",\
\
      "issuerId": "7",\
\
      "stakeholderId": "6113",\
\
      "equityIncentivePlanName": "2015 Equity Incentive Plan",\
\
      "issueDate": {\
\
        "value": "2015-06-01"\
\
      },\
\
      "vestingStartDate": {\
\
        "value": "2015-06-01"\
\
      },\
\
      "boardApprovalDate": {\
\
        "value": "2015-06-01"\
\
      },\
\
      "stakeholderAcceptanceDate": {\
\
        "value": "2017-02-27"\
\
      },\
\
      "quantity": {\
\
        "value": "1500"\
\
      },\
\
      "vestedQuantity": {\
\
        "value": "1500"\
\
      },\
\
      "releasedQuantity": {\
\
        "value": "200"\
\
      },\
\
      "releasePricePerShare": {\
\
        "currencyCode": {\
\
          "value": "USD"\
\
        },\
\
        "amount": {\
\
          "value": "0.78"\
\
        }\
\
      },\
\
      "netSettledQuantity": {\
\
        "value": "145"\
\
      },\
\
      "securityLabel": "RSU-7",\
\
      "vestingEvents": [\
\
        {\
\
          "id": "1988",\
\
          "vestDate": {\
\
            "value": "2016-06-01"\
\
          },\
\
          "quantity": {\
\
            "value": "375"\
\
          },\
\
          "performanceCondition": false,\
\
          "vested": true,\
\
          "maxQuantity": {\
\
            "value": "375"\
\
          },\
\
          "targetQuantity": {\
\
            "value": "375"\
\
          },\
\
          "vestedQuantity": {\
\
            "value": "375"\
\
          }\
\
        }\
\
      ],\
\
      "settlements": [\
\
        {\
\
          "settlementDate": {\
\
            "value": "2016-08-19"\
\
          },\
\
          "releaseQuantity": {\
\
            "value": "200"\
\
          },\
\
          "saleQuantity": {\
\
            "value": "200"\
\
          },\
\
          "withholdingQuantity": {\
\
            "value": "55"\
\
          },\
\
          "netSettlementQuantity": {\
\
            "value": "145"\
\
          },\
\
          "settlementPrice": {\
\
            "currencyCode": {\
\
              "value": "USD"\
\
            },\
\
            "amount": {\
\
              "value": "0.78"\
\
            }\
\
          },\
\
          "certificateId": "78",\
\
          "certificateLabel": "CS-124"\
\
        }\
\
      ],\
\
      "vestingSchedule": {\
\
        "name": "1/24 Cliff",\
\
        "lastModifiedDate": {\
\
          "value": "2022-01-31"\
\
        },\
\
        "startDate": {\
\
          "value": "2015-06-01"\
\
        },\
\
        "endDate": {\
\
          "value": "2024-01-31"\
\
        }\
\
      },\
\
      "lastModifiedDatetime": {\
\
        "value": "2024-07-30T09:31:57.000000Z"\
\
      }\
\
    }\
\
  ],

"nextPageToken": "ODU3NA=="

}

URL Expired

``200 A successful 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.

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