URL Expired

The URL for this request expired after 30 days.

Request Parameters

issuerId

• type: string
• required
  The identifier of the issuer that issued the interests.

asOfDate

• type: string Retrieves the interests as of the given date, specified as an ISO 8601 extended format calendar date, i.e. 'YYYY-MM-DD'.

pageSize

• type: int32
  The maximum number of interests to return. The service may return fewer than this value.
  If unspecified, at most 100 interests will be returned.
  The maximum value is 100; values above 100 will be coerced to 100.

pageToken

• type: string
  The page token received from a previous List Interests call. Provide this token to retrieve the subsequent page.
  When paginating, all other parameters provided to List Interests must match the call that received the page token.

Response Structure

200 Successful Response

• object: The response from the List Interests endpoint.

  • asOfDate: object

    • required
      The date as of which the interests information was requested. This field will default to the date when the interest information was retrieved (i.e., today's date).
    • value: string
      • length between 10 and 10
      • format: [0-9]{4}-[0-9]{2}-[0-9]{2}

  • interests: array of objects

    • required
      The interests for the specified issuer.
    • interests: object
      • id: string
        The unique identifier for the interest.
      • issuerId: string
        The unique identifier for the issuer of the interest.
      • stakeholderId: string
        The unique identifier for the stakeholder that the interest is issued to.
      • interestLabel: string
        The label of the interest.
      • interestTypeName: string
        The name of the interest type.
      • issueDate: object
        The effective date of the interest.
      • acceptanceDate: object
        The date the interest was accepted by the holder.
      • thresholdDetails: object
        Threshold details for the interest.
      • exercisePrice: object
        The strike price at which units of this interest type can be exercised.
      • originalIssuePrice: object
        The price at which units of the interest type were issued.
      • investedCapital: object
        The amount invested by an investor to secure an interest.
      • accruedValue: object
        Value accrued on principal amount as of the effective date.
      • issuedQuantity: object
        The number of units represented by this interest.
      • outstandingQuantity: object
        The number of outstanding units, units that are 'active' for the interest.
      • outstandingVestedQuantity: object
        The number of outstanding vested units.
      • exercisedQuantity: object
        The number of exercised units.
      • repurchasedQuantity: object
        The number of repurchased units.
      • cancelledQuantity: object
        The number of cancelled units.
      • forfeitedQuantity: object
        The number of forfeited units.
      • vestingSchedule: object
        Vesting Schedule for the interest if it has vesting behaviour enabled.

Pagination

• 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.

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.

Curl Example

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

Example Response

{
  "asOfDate": {
    "value": "2021-01-01"
  },
  "interests": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "issuerId": "123e4567-e89b-12d3-a456-426614174001",
      "stakeholderId": "123e4567-e89b-12d3-a456-426614174002",
      "interestLabel": "MIU-1",
      "interestTypeName": "Management Incentive Unit",
      "issueDate": {
        "value": "2024-01-01"
      },
      "acceptanceDate": {
        "value": "2024-01-02T00:00:00Z"
      },
      "thresholdDetail": {
        "amount": {
          "value": "1000.0"
        },
        "type": "THRESHOLD_TYPE_PER_UNIT"
      },
      "exercisePrice": {
        "currencyCode": {
          "value": "USD"
        },
        "amount": {
          "value": "50.0"
        }
      },
      "originalIssuePrice": {
        "currencyCode": {
          "value": "USD"
        },
        "amount": {
          "value": "45.0"
        }
      },
      "investedCapital": {
        "currencyCode": {
          "value": "USD"
        },
        "amount": {
          "value": "100.0"
        }
      },
      "accruedValue": {
        "currencyCode": {
          "value": "USD"
        },
        "amount": {
          "value": "200.0"
        }
      },
      "issuedQuantity": {
        "value": "100.0"
      },
      "outstandingQuantity": {
        "value": "100.0"
      },
      "outstandingVestedQuantity": {
        "value": "100.0"
      },
      "exercisedQuantity": {
        "value": "0"
      },
      "repurchasedQuantity": {
        "value": "0"
      },
      "cancelledQuantity": {
        "value": "0"
      },
      "forfeitedQuantity": {
        "value": "0"
      },
      "vestingSchedule": {
        "name": "Standard Vesting",
        "startDate": {
          "value": "2024-01-01"
        }
      }
    }
  ],
  "nextPageToken": "Nzg2Mg=="
}