--- canonical_url: "https://docs.composio.dev/toolkits/carta" markdown_url: "https://docs.composio.dev/toolkits/carta.md" product: "platform" version: null last_updated: null --- # Carta Carta provides equity, cap table, compensation, portfolio, and fund administration APIs. - **Category:** accounting - **Auth:** OAUTH2, S2S_OAUTH2 - **Composio-managed OAuth available?** No - **Tools:** 83 - **Triggers:** 0 - **Slug:** `CARTA` - **Version:** 00000000_00 ## Tools ### Adjust Investor Capital Call **Slug:** `CARTA_ADJUST_INVESTOR_CAPITAL_CALL` Changes a capital call's total amount and reallocates it across interests while retaining the capital call ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `note` | string | No | Optional note explaining why the capital call changed. | | `amount` | object | Yes | The new total amount to call in the fund's currency. | | `firm_id` | string | Yes | The ID of the firm that owns the fund. | | `fund_id` | string | Yes | The ID of the fund containing the capital call. | | `source_system` | string | Yes | The system that sent the adjustment. | | `capital_call_id` | string | Yes | The ID of the capital call to adjust. | | `external_reference_id` | string | Yes | A unique reference for this adjustment, used for idempotency. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Draft Issuer **Slug:** `CARTA_CREATE_DRAFT_ISSUER` Create a draft version of an issuer in Carta Launch. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `draft_issuer` | object | No | Draft issuer to create. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Investor Capital Call **Slug:** `CARTA_CREATE_INVESTOR_CAPITAL_CALL` Create a capital call and allocate its fund-level amount across selected interests, or every interest when interest_ids is empty. By default, the call remains a draft. Warning: post_as_draft=false releases it to limited partners and posts its journal. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `amount` | object | Yes | The total amount to call in the fund's currency. | | `firm_id` | string | Yes | The ID of the firm that owns the fund. | | `fund_id` | string | Yes | The ID of the fund in which to create the capital call. | | `purpose` | string | No | Optional purpose retained with the capital call in Carta. | | `due_date` | object | Yes | The date by which partners must pay. | | `interest_ids` | array | No | Fund interest IDs to call. An empty list calls every interest in the fund. | | `post_as_draft` | boolean | No | Defaults to true, which leaves the call as a draft; false releases the call to limited partners and posts its journal. | | `source_system` | string | Yes | The system that sent the capital call. | | `payment_details_id` | string | No | Optional ID of the fund payment account into which partners pay. | | `external_reference_id` | string | Yes | The caller's unique reference for this capital call, used for idempotency. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Investor Carried Interest Allocation **Slug:** `CARTA_CREATE_INVESTOR_CARRIED_INTEREST_ALLOCATION` Books externally calculated carried-interest changes as a manual allocation. The deltas must net to zero; no journal is posted. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `notes` | string | No | Optional notes recorded on the allocation. | | `deltas` | array | Yes | Per-interest changes, which must net to zero and use at most two decimal places. | | `firm_id` | string | Yes | The ID of the firm that owns the fund. | | `fund_id` | string | Yes | The ID of the fund in which to book the allocation. | | `source_system` | string | Yes | The system that calculated the carried interest. | | `effective_date` | object | Yes | The accounting date of the allocation. | | `external_reference_id` | string | Yes | The caller's unique reference for this allocation, used for idempotency. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Investor Management Fee **Slug:** `CARTA_CREATE_INVESTOR_MANAGEMENT_FEE` Book an externally calculated limited-partner management fee and post its journal. Per-interest amounts must sum exactly to the total amount. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `amount` | object | Yes | The total fee in the fund's currency; it must equal interest_amounts. | | `firm_id` | string | Yes | The ID of the firm that owns the fund. | | `fund_id` | string | Yes | The ID of the fund in which to book the fee. | | `period_end` | object | Yes | The last day of the fee period. | | `period_start` | object | Yes | The first day of the fee period. | | `source_system` | string | Yes | The system that calculated the fee. | | `effective_date` | object | Yes | The accounting date of the fee journal. | | `interest_amounts` | array | Yes | The fee charged to each fund interest. | | `external_reference_id` | string | Yes | The caller's unique reference for this fee, used for idempotency. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Issuer Draft Option Grant **Slug:** `CARTA_CREATE_ISSUER_DRAFT_OPTION_GRANT` Create a draft option grant in an issuer's draft option grant set. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `issuer_id` | string | Yes | Identifier of the issuer of the grant. | | `draft_option_grant` | object | Yes | Draft option grant to create. | | `draft_option_grant_set_id` | string | Yes | Draft option grant set identifier, or "LATEST" to use or create the most recent set. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Issuer Secondary Transaction **Slug:** `CARTA_CREATE_ISSUER_SECONDARY_TRANSACTION` Create a secondary transaction on an issuer's capitalization table with the supplied external reference, right-of-first-refusal decision, buyer, price, and securities. Carta assigns its identifier, state, settlement fields, and finalization time. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `issuer_id` | string | Yes | Identifier of the issuer under which the transaction is recorded. | | `securities` | array | Yes | Securities being sold, one entry per security. | | `price_per_share` | object | Yes | Sale price for one share; Carta V1 requires USD. | | `buyer_information` | object | No | Buyer receiving the securities; required for transfer outcomes and omitted for a company repurchase. | | `external_reference_id` | string | Yes | Unique caller reference used to reconcile and recognize retries. | | `right_of_first_refusal` | object | Yes | Issuer's right-of-first-refusal decision. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Download Portfolio Fund Investment Document **Slug:** `CARTA_DOWNLOAD_PORTFOLIO_FUND_INVESTMENT_DOCUMENT` Download a portfolio fund investment document from Carta's temporary URL and return it as a stored file reference with its metadata and expiration. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `document_id` | string | Yes | ID of the fund investment document to download. | | `portfolio_id` | string | Yes | ID of the portfolio holding the fund investment document. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Finalize Issuer Secondary Transaction **Slug:** `CARTA_FINALIZE_ISSUER_SECONDARY_TRANSACTION` Irreversibly finalize an existing issuer secondary transaction for settlement. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `issuer_id` | string | Yes | Identifier of the issuer that owns the transaction. | | `secondary_transaction_id` | string | Yes | Carta identifier of the existing transaction to finalize. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Compensation Benchmark Attributes **Slug:** `CARTA_GET_COMPENSATION_BENCHMARK_ATTRIBUTES` Retrieve valid compensation benchmark attributes for a corporation's Carta Total Compensation plan. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `corporation_id` | string | Yes | Corporation or issuer identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Current User **Slug:** `CARTA_GET_CURRENT_USER` Retrieve the Carta user associated with the access token that authorized the request. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Draft Issuer **Slug:** `CARTA_GET_DRAFT_ISSUER` Retrieve a draft issuer from Carta Launch by identifier. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Draft issuer identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Investor Capital Call **Slug:** `CARTA_GET_INVESTOR_CAPITAL_CALL` Retrieves a capital call, including its status and allocation across the fund's interests. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `firm_id` | string | Yes | The ID of the firm that owns the fund. | | `fund_id` | string | Yes | The ID of the fund containing the capital call. | | `capital_call_id` | string | Yes | The capital call ID returned by Create Investor Capital Call. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Investor Capitalization Table **Slug:** `CARTA_GET_INVESTOR_CAPITALIZATION_TABLE` Retrieve one capitalization table for a company investment within a specified investor firm and fund, optionally as of a date. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `firm_id` | string | Yes | The identifier of the firm. | | `fund_id` | string | Yes | The identifier of the fund. | | `as_of_date` | string | No | Return capitalization table state as of this date in YYYY-MM-DD format. | | `company_id` | string | Yes | The identifier of the investment company. | | `capitalization_table_id` | string | Yes | The identifier of the capitalization table. For a company's primary capitalization table, this is the same as company_id. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Investor Management Fee **Slug:** `CARTA_GET_INVESTOR_MANAGEMENT_FEE` Retrieves a management fee booked through Create Investor Management Fee, including the current state of its journal. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `firm_id` | string | Yes | The ID of the firm that owns the fund. | | `fund_id` | string | Yes | The ID of the fund in which the fee was booked. | | `management_fee_id` | string | Yes | The management fee ID returned when the fee was created. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Investor Stakeholder Capitalization Table **Slug:** `CARTA_GET_INVESTOR_STAKEHOLDER_CAPITALIZATION_TABLE` Retrieve one page of stakeholder-group capitalization data for a company investment within a specified investor firm and fund, optionally as of a date. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `firm_id` | string | Yes | The identifier of the firm. | | `fund_id` | string | Yes | The identifier of the fund. | | `page_size` | integer | No | Maximum stakeholder groups to return on this page. Defaults to 25; values above 50 are coerced to 50. | | `as_of_date` | string | No | Return stakeholder capitalization table state as of this date in YYYY-MM-DD format. | | `company_id` | string | Yes | The identifier of the investment company. | | `page_token` | string | No | The next_cursor from a previous call. Keep all other parameters unchanged when requesting the next page. | | `capitalization_table_id` | string | Yes | The identifier of the capitalization table. For a company's primary capitalization table, this is the same as company_id. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Investor Waterfall Result **Slug:** `CARTA_GET_INVESTOR_WATERFALL_RESULT` Retrieve one saved waterfall result for a Carta investment firm by result ID. This beta endpoint requires access from a Carta representative. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `firm_id` | string | Yes | The ID of the firm, as List Firms returns it. | | `waterfall_result_id` | string | Yes | The ID of the saved waterfall result. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Issuer **Slug:** `CARTA_GET_ISSUER` Retrieve one issuer accessible to the connected account by issuer ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The identifier of the issuer to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Issuer Capitalization Table **Slug:** `CARTA_GET_ISSUER_CAPITALIZATION_TABLE` Retrieve an issuer's capitalization table by share class. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `issuer_id` | string | Yes | The identifier of the issuer. | | `as_of_date` | string | No | Retrieves the capitalization table as of the given date, specified as an [ISO 8601 extended format calendar date](https://en.wikipedia.org/wiki/ISO_8601#Calendar_dates), i.e. 'YYYY-MM-DD'. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Issuer Certificate **Slug:** `CARTA_GET_ISSUER_CERTIFICATE` Retrieve one certificate belonging to the specified issuer by certificate ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The identifier of the certificate to retrieve. | | `issuer_id` | string | Yes | The identifier of the issuer owning the certificate to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Issuer Convertible Note **Slug:** `CARTA_GET_ISSUER_CONVERTIBLE_NOTE` Retrieve one convertible note belonging to the specified issuer by note ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The identifier of the convertible note to retrieve. | | `issuer_id` | string | Yes | The identifier of the issuer owning the convertible note to retrieve | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Issuer Draft Option Grant **Slug:** `CARTA_GET_ISSUER_DRAFT_OPTION_GRANT` Retrieve a draft option grant from an issuer's draft option grant set. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `issuer_id` | string | Yes | Identifier of the issuer of the grant. | | `draft_option_grant_id` | string | Yes | Identifier of the draft option grant to retrieve. | | `draft_option_grant_set_id` | string | Yes | Identifier of the draft option grant set containing the grant. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Issuer Option Grant **Slug:** `CARTA_GET_ISSUER_OPTION_GRANT` Retrieve one option grant issued by the specified issuer by grant ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The identifier of the option grant to retrieve. | | `issuer_id` | string | Yes | The identifier of the issuer that issued the option grant. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Issuer Restricted Stock Award **Slug:** `CARTA_GET_ISSUER_RESTRICTED_STOCK_AWARD` Retrieve one restricted stock award issued by the specified issuer by award ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The identifier of the restricted stock award to retrieve. | | `issuer_id` | string | Yes | The identifier of the issuer owning the restricted stock award to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Issuer Restricted Stock Unit **Slug:** `CARTA_GET_ISSUER_RESTRICTED_STOCK_UNIT` Retrieve one restricted stock unit issued by the specified issuer by unit ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The identifier of the restricted stock unit. | | `issuer_id` | string | Yes | The identifier of the issuer owning the restricted stock unit to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Issuer Secondary Transaction **Slug:** `CARTA_GET_ISSUER_SECONDARY_TRANSACTION` Retrieve a secondary transaction from an issuer's capitalization table. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `issuer_id` | string | Yes | Identifier of the issuer that owns the transaction. | | `secondary_transaction_id` | string | Yes | Carta identifier of the secondary transaction to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Issuer Stakeholder **Slug:** `CARTA_GET_ISSUER_STAKEHOLDER` Retrieve one stakeholder belonging to the specified issuer by stakeholder ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The identifier of the stakeholder to retrieve. | | `issuer_id` | string | Yes | The identifier of the issuer owning the stakeholder to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Issuer Stakeholder Capitalization Table **Slug:** `CARTA_GET_ISSUER_STAKEHOLDER_CAPITALIZATION_TABLE` Retrieve one page of an issuer's capitalization table grouped by stakeholder, optionally as of a date. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `issuer_id` | string | Yes | The identifier of the issuer whose stakeholder capitalization table is being retrieved. | | `page_size` | integer | No | The maximum number of StakeholderGroups to return. The service may return fewer than this value. If unspecified, at most 25 StakeholderGroups will be returned. The maximum value is 100; values above 100 will be coerced to 100. | | `as_of_date` | string | No | Retrieve stakeholder capitalization table state as of given `as_of_date`. Format: 'YYYY-MM-DD' Retrieve stakeholder capitalization table state as of given `asOfDate`, specified as an [ISO-8601 calendar date](https://en.wikipedia.org/wiki/ISO_8601) in the format of 'YYYY-MM-DD'. | | `next_cursor` | string | No | A page token, received from a previous Get Stakeholder Capitalization Table call. Provide this token to retrieve the subsequent page. When paginating, all other parameters provided to `GetStakeholderCapitalizationTable` must match the call that received the page token. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Issuer Stakeholder Equity Summary **Slug:** `CARTA_GET_ISSUER_STAKEHOLDER_EQUITY_SUMMARY` Retrieves a summary of a stakeholder's equity positions — certificates, option grants (ISO and NSO), restricted stock awards, and restricted stock units — at a given issuer. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `issuer_id` | string | Yes | The identifier of the issuer. | | `as_of_date` | string | No | Return the equity summary as of this date, specified as an [ISO 8601 extended format calendar date](https://en.wikipedia.org/wiki/ISO_8601#Calendar_dates), i.e. 'YYYY-MM-DD'. Defaults to today when omitted. | | `stakeholder_id` | string | Yes | The identifier of the stakeholder. | | `include_canceled` | boolean | No | When true, canceled securities are included in exercised and settled quantity totals. Canceled securities are always excluded from total, vested, and outstanding quantities. Defaults to false. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Issuer Stock Split Asset Changes **Slug:** `CARTA_GET_ISSUER_STOCK_SPLIT_ASSET_CHANGES` For a set of securities and a reference time, report stock-split-driven changes. Store the returned `asOf` timestamp and send it back as `since` on the next request. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `since` | object | Yes | The reference time. Only stock splits that occurred after this time are considered. Provide the `asOf` value from a previous response rather than a time from your own clock. | | `issuer_id` | string | Yes | The identifier of the issuer that owns the securities. | | `securities` | array | Yes | The securities to check for stock-split-driven changes. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Open Cap Table **Slug:** `CARTA_GET_OPEN_CAP_TABLE` Get the processing record for a previously uploaded OCF package. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Identifier of the open cap table upload to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Portfolio **Slug:** `CARTA_GET_PORTFOLIO` Retrieve a shareholder portfolio by identifier. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `portfolio_id` | string | Yes | Identifier of the portfolio to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Portfolio Issuer Certificate **Slug:** `CARTA_GET_PORTFOLIO_ISSUER_CERTIFICATE` Retrieve one certificate for the specified issuer within the specified portfolio by certificate ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `issuer_id` | string | Yes | The identifier of the issuer that has issued the certificate. | | `portfolio_id` | string | Yes | The identifier of the portfolio holding the certificate to retrieve. | | `certificate_id` | string | Yes | The identifier of the certificate to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Portfolio Issuer Convertible Note **Slug:** `CARTA_GET_PORTFOLIO_ISSUER_CONVERTIBLE_NOTE` Retrieve one convertible note for the specified issuer within the specified portfolio by note ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The identifier of the convertible note to retrieve. | | `issuer_id` | string | Yes | The identifier of the issuer owning the convertible note to retrieve | | `portfolio_id` | string | Yes | The identifier of the portfolio holding the convertible note to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Portfolio Issuer Fair Market Value **Slug:** `CARTA_GET_PORTFOLIO_ISSUER_FAIR_MARKET_VALUE` Retrieve the current fair market value of an issuer in a portfolio. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `issuer_id` | string | Yes | Identifier of the issuer whose fair market value to retrieve. | | `portfolio_id` | string | Yes | Identifier of the portfolio containing the issuer holdings. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Portfolio Issuer Option Grant **Slug:** `CARTA_GET_PORTFOLIO_ISSUER_OPTION_GRANT` Retrieve one option grant for the specified issuer within the specified portfolio by grant ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `issuer_id` | string | Yes | The identifier of the issuer that has issued the option grant. | | `portfolio_id` | string | Yes | The identifier of the portfolio holding the option grant. | | `option_grant_id` | string | Yes | The identifier of the option grant to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Portfolio Issuer Restricted Stock Award **Slug:** `CARTA_GET_PORTFOLIO_ISSUER_RESTRICTED_STOCK_AWARD` Retrieve one restricted stock award for the specified issuer within the specified portfolio by award ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `issuer_id` | string | Yes | The identifier of the issuer that has issued the restricted stock award to retrieve. | | `portfolio_id` | string | Yes | The identifier of the portfolio holding the restricted stock award to retrieve. | | `restricted_stock_award_id` | string | Yes | The identifier of the restricted stock award to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Portfolio Issuer Restricted Stock Unit **Slug:** `CARTA_GET_PORTFOLIO_ISSUER_RESTRICTED_STOCK_UNIT` Retrieve one restricted stock unit for the specified issuer within the specified portfolio by unit ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `issuer_id` | string | Yes | The identifier of the issuer that has issued the restricted stock unit to retrieve. | | `portfolio_id` | string | Yes | The identifier of the portfolio holding the restricted stock unit to retrieve. | | `restricted_stock_unit_id` | string | Yes | The identifier of the restricted stock unit to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Compensation Benchmarks **Slug:** `CARTA_LIST_COMPENSATION_BENCHMARKS` Retrieve one page of compensation benchmarks for a corporation's Carta Total Compensation plan. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor returned by a previous call. Keep all filters unchanged. | | `job_area` | string | Yes | Job area used to segment benchmark data. | | `job_level` | string | No | Job level; omit or pass an empty string for all levels. | | `page_size` | integer | No | Maximum benchmarks to return. Carta defaults to and caps this at 100. | | `corporation_id` | string | Yes | Corporation or issuer identifier. | | `compensation_type` | string | No | Compensation type; omit or pass an empty string for all types. | | `job_specialization` | string | No | Job specialization; omit or pass an empty string for the roll-up segment. | | `geo_adjustment_location` | string | Yes | Location used to geo-adjust benchmarks. | | `post_money_valuation_bucket` | string | Yes | Peer group used to segment benchmark data. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Corporations **Slug:** `CARTA_LIST_CORPORATIONS` Retrieve one page of corporations that the connected Carta user can access. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. | | `page_size` | integer | No | Maximum corporations to return. Carta defaults to 25 and coerces values above 50 to 50. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Investor Capitalization Tables **Slug:** `CARTA_LIST_INVESTOR_CAPITALIZATION_TABLES` Retrieves the capitalization tables for a given firm, fund, and investment company. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `firm_id` | string | Yes | The identifier of the firm. | | `fund_id` | string | Yes | The identifier of the fund. | | `page_size` | integer | No | The maximum number of capitalization tables to return. The service may return fewer than this value. If unspecified, at most 25 capitalization tables will be returned. The maximum value is 50; values above 50 will be coerced to 50. | | `company_id` | string | Yes | The identifier of the investment company. | | `page_token` | string | No | A page token, received from a previous List Capitalization Tables call. Provide this token to retrieve the subsequent page. When paginating, all other parameters provided to `ListCapitalizationTables` must match the call that received the page token. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Investor Cash Balances **Slug:** `CARTA_LIST_INVESTOR_CASH_BALANCES` Retrieves one page of cash balances for a firm and fund. Pass '-' as fund_id to retrieve balances across all funds in the firm. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `firm_id` | string | Yes | The firm ID for which to retrieve cash balances. | | `fund_id` | string | Yes | The fund ID, or '-' to retrieve balances across every fund in the firm. | | `page_size` | integer | No | Maximum results to return. Carta defaults to 25 and coerces values above 50 to 50. | | `page_token` | string | No | The next_cursor returned by the previous page; omit for the first page. | | `as_of_date_time` | string | No | Optional UTC ISO 8601 date-time as of which to retrieve balances. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Investor Certificates **Slug:** `CARTA_LIST_INVESTOR_CERTIFICATES` Retrieve certificates issued by an investment company to a fund within a firm. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `firm_id` | string | Yes | The identifier of the firm. | | `fund_id` | string | Yes | The identifier of the fund or `-` to list certificates across all funds under the firm specified by `firmId`. | | `page_size` | integer | No | The maximum number of certificates to return. The service may return fewer than this value. If unspecified, at most 25 certificates will be returned. The maximum value is 100; values above 100 will be coerced to 100. | | `as_of_date` | string | No | *Deprecated* Return certificates with issue dates on or after this date, specified as an [ISO 8601 extended format calendar date](https://en.wikipedia.org/wiki/ISO_8601#Calendar_dates), i.e. 'YYYY-MM-DD'. | | `page_token` | string | No | A page token received as `nextPageToken` in a previous `ListCertificates` response. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCertificates` must match the call that provided the page token. | | `investment_id` | string | Yes | The identifier of the investment or `-` to list certificates across all company investments under the fund specified by `firmId` and `fundId`. | | `last_modified_datetime_after` | string | No | Return certificates that were last modified on or after this date and time. Uses UTC and is specified in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), i.e. 'YYYY-MM-DDThh:mm:ssZ'. | | `last_modified_datetime_before` | string | No | Return certificates that were last modified on or before this date and time. Uses UTC and is specified in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), i.e. 'YYYY-MM-DDThh:mm:ssZ'. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Investor Convertible Notes **Slug:** `CARTA_LIST_INVESTOR_CONVERTIBLE_NOTES` Retrieve convertible notes and SAFEs issued by an investment company to a fund within a firm. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `firm_id` | string | Yes | The identifier of the firm. | | `fund_id` | string | Yes | The identifier of the fund or `-` to list convertible notes across all funds under the firm specified by `firm_id`. | | `page_size` | integer | No | The maximum number of convertible notes to return. The service may return fewer than this value. If unspecified, at most 25 convertible notes will be returned. The maximum value is 100; values above 100 will be coerced to 100. | | `as_of_date` | string | No | *Deprecated* Return convertible notes with issue dates on or after this date, specified as an [ISO 8601 extended format calendar date](https://en.wikipedia.org/wiki/ISO_8601#Calendar_dates), i.e. 'YYYY-MM-DD'. | | `page_token` | string | No | A page token received as `nextPageToken` in a previous `ListConvertibleNotes` response. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConvertibleNotes` must match the call that provided the page token. | | `investment_id` | string | Yes | The identifier of the investment or `-` to list convertible notes across all company investments under the fund specified by `firmId` and `fundId`. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Investor Firm Performance Metrics **Slug:** `CARTA_LIST_INVESTOR_FIRM_PERFORMANCE_METRICS` Retrieve one page of performance metrics aggregated across selected funds in a Carta firm. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `firm_id` | string | Yes | Firm ID whose aggregated fund performance metrics to retrieve. | | `fund_ids` | string | No | Comma-separated fund IDs to aggregate; omit to aggregate all funds. | | `group_by` | string ("AGGREGATION_TYPE_BY_PARTNER_TYPE" | "AGGREGATION_TYPE_BY_PARTNER_GROUP") | No | Optional partner-type or partner-group aggregation. | | `page_size` | integer | No | Maximum results. Carta defaults to 25 and coerces values above 50 to 50. | | `page_token` | string | No | Token returned by a previous call. Keep all other parameters unchanged. | | `as_of_date_time` | string | No | UTC ISO 8601 cutoff; omit to use the current date and time. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Investor Firms **Slug:** `CARTA_LIST_INVESTOR_FIRMS` Retrieve one page of investment firms available to the connected Carta account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page_size` | integer | No | Maximum firms to return. Carta defaults to 25 and coerces values above 50 to 50. | | `page_token` | string | No | Token returned by a previous call. Keep all other parameters unchanged. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Investor Fund Interests **Slug:** `CARTA_LIST_INVESTOR_FUND_INTERESTS` Retrieves one page of partner interests in a fund. An interest id is distinct from partnerId and is used by management-fee and carried-interest actions. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `firm_id` | string | Yes | The ID of the firm that owns the fund. | | `fund_id` | string | Yes | The ID of the fund. | | `page_size` | integer | No | Maximum interests to return. Carta defaults to 50 and coerces values above 100 to 100. | | `page_token` | string | No | The next_cursor returned by the previous page; omit for the first page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Investor Fund Performance Metrics **Slug:** `CARTA_LIST_INVESTOR_FUND_PERFORMANCE_METRICS` Retrieve one page of Carta fund performance metrics, optionally grouped by fund, partner type, or partner. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `firm_id` | string | Yes | Firm ID whose fund performance metrics to retrieve. | | `fund_id` | string | Yes | Fund ID, or '-' to retrieve metrics for all funds. | | `page_size` | integer | No | Maximum results. Carta defaults to 25 and coerces values above 50 to 50. | | `page_token` | string | No | Token returned by a previous call. Keep all other parameters unchanged. | | `report_type` | string ("BY_FUND" | "BY_PARTNER_TYPE" | "BY_PARTNER") | No | Metrics grouping. Omit to default to BY_FUND. | | `as_of_date_time` | string | No | UTC ISO 8601 cutoff; omit to use the current date and time. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Investor Funds **Slug:** `CARTA_LIST_INVESTOR_FUNDS` Retrieve one page of investment funds belonging to a Carta investment firm. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `firm_id` | string | Yes | Identifier of the firm holding the funds. | | `page_size` | integer | No | Maximum funds to return. Carta defaults to 25 and coerces values above 50 to 50. | | `page_token` | string | No | Token returned by a previous call. Keep all other parameters unchanged. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Investor Investments **Slug:** `CARTA_LIST_INVESTOR_INVESTMENTS` Retrieve one page of portfolio-company investments held by a Carta fund. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `firm_id` | string | Yes | Firm identifier. | | `fund_id` | string | Yes | Fund identifier. | | `page_size` | integer | No | Maximum investments to return. Carta defaults to 25 and coerces values above 50 to 50. | | `page_token` | string | No | Token returned by a previous call. Keep all other parameters unchanged. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Investor Partner Contacts **Slug:** `CARTA_LIST_INVESTOR_PARTNER_CONTACTS` Retrieve one page of contacts associated with partners across a Carta firm's funds. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `firm_id` | string | Yes | Firm identifier whose partner contacts to retrieve. | | `fund_ids` | string | No | Comma-separated fund IDs to filter by; omit to include all funds. | | `page_size` | integer | No | Maximum contacts to return. Carta defaults to 50 and coerces values above 100 to 100. | | `page_token` | string | No | Token returned by a previous call. Keep all other parameters unchanged. | | `partner_ids` | string | No | Comma-separated partner IDs to filter by; omit to include all partners. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Investor Partners **Slug:** `CARTA_LIST_INVESTOR_PARTNERS` Retrieve one page of LPs, GPs, and other partners across a Carta firm's funds. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `firm_id` | string | Yes | Firm identifier whose partners to retrieve. | | `fund_ids` | string | No | Comma-separated fund IDs to filter by; omit to include all funds. | | `group_id` | string | No | Partner group ID to filter by; omit to include all groups. | | `page_size` | integer | No | Maximum partners to return. Carta defaults to 50 and coerces values above 100 to 100. | | `page_token` | string | No | Token returned by a previous call. Keep all other parameters unchanged. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Investor Warrants **Slug:** `CARTA_LIST_INVESTOR_WARRANTS` Retrieve investment warrants issued by an investment company to a fund within a firm. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `firm_id` | string | Yes | The identifier of the firm. | | `fund_id` | string | Yes | The identifier of the fund or `-` to list warrants across all funds under the firm specified by `firmId`. | | `page_size` | integer | No | The maximum number of warrants to return. The service may return fewer than this value. If unspecified, at most 25 warrants will be returned. The maximum value is 100; values above 100 will be coerced to 100. | | `as_of_date` | string | No | *Deprecated* Return warrants with issue dates on or after this date, specified as an [ISO 8601 extended format calendar date](https://en.wikipedia.org/wiki/ISO_8601#Calendar_dates), i.e. 'YYYY-MM-DD'. | | `page_token` | string | No | A page token received as `nextPageToken` in a previous `ListWarrants` response. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWarrants` must match the call that provided the page token. | | `investment_id` | string | Yes | The identifier of the investment or `-` to list warrants across all company investments under the fund specified by `firmId` and `fundId`. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Investor Waterfall Holdings **Slug:** `CARTA_LIST_INVESTOR_WATERFALL_HOLDINGS` List feeder-fund holdings from saved waterfall results, including value, ownership, invested capital, and MOIC. This beta endpoint requires access from a Carta representative. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `firm_id` | string | Yes | The firm_id returned by LIST_INVESTOR_FIRMS. | | `fund_id` | string | Yes | The fund_id returned by LIST_INVESTOR_FUNDS, or `-` for every accessible fund. | | `page_size` | integer | No | The maximum number of results to return. The service may return fewer than this value. If unspecified, at most 25 items will be returned. The maximum value is 50; values above 50 will be coerced to 50. | | `target_id` | string | No | Only rows for this deal structure or company. Requires waterfall_date_start and waterfall_date_end. | | `page_token` | string | No | The next_cursor from a previous call. Keep all other parameters unchanged when requesting the next page. | | `saved_at_start` | string | No | Only rows saved at or after this UTC time. Combine with waterfall_result_id, or with target_id and both waterfall date parameters. | | `waterfall_date_end` | string | No | Only rows of results with a waterfall date on or before this date, as `YYYY-MM-DD`. | | `waterfall_result_id` | string | No | Only rows of this saved waterfall result. | | `waterfall_date_start` | string | No | Only rows of results with a waterfall date on or after this date, as `YYYY-MM-DD`. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Investor Waterfall Results **Slug:** `CARTA_LIST_INVESTOR_WATERFALL_RESULTS` List a firm's saved waterfall-modeling results, newest waterfall date first; unsaved runs and finalized portfolio valuations are excluded. This beta endpoint requires access from a Carta representative. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `firm_id` | string | Yes | The ID of the firm, as List Firms returns it. | | `page_size` | integer | No | The maximum number of results to return. The service may return fewer than this value. If unspecified, at most 25 items will be returned. The maximum value is 50; values above 50 will be coerced to 50. | | `target_id` | string | No | Only results run on this deal structure or company. | | `page_token` | string | No | A page token received as `nextPageToken` in a previous 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. | | `target_type` | string ("WATERFALL_TARGET_TYPE_DEAL_GROUP" | "WATERFALL_TARGET_TYPE_COMPANY") | No | Only results run on this kind of target. - WATERFALL_TARGET_TYPE_DEAL_GROUP: A deal structure: a portfolio company and the holding entities above it. - WATERFALL_TARGET_TYPE_COMPANY: A single portfolio company. | | `saved_at_start` | string | No | Only results saved at or after this time (UTC). Use the time of your last sync to read only what changed. Saving a run again keeps its `id` and moves its `savedAt`, so you can replace your stored copy. | | `waterfall_date_end` | string | No | Only results with a waterfall date on or before this date, as `YYYY-MM-DD`. | | `waterfall_date_start` | string | No | Only results with a waterfall date on or after this date, as `YYYY-MM-DD`. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Investor Waterfall Targets **Slug:** `CARTA_LIST_INVESTOR_WATERFALL_TARGETS` List deal structures and companies a Carta investment firm can run waterfalls on, including each target's stable ID and feeder funds. This beta endpoint requires access from a Carta representative. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `firm_id` | string | Yes | The ID of the firm, as List Firms returns it. | | `page_size` | integer | No | The maximum number of results to return. The service may return fewer than this value. If unspecified, at most 25 items will be returned. The maximum value is 50; values above 50 will be coerced to 50. | | `page_token` | string | No | A page token received as `nextPageToken` in a previous 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. | | `target_type` | string ("WATERFALL_TARGET_TYPE_DEAL_GROUP" | "WATERFALL_TARGET_TYPE_COMPANY") | No | Only targets of this kind. - WATERFALL_TARGET_TYPE_DEAL_GROUP: A deal structure: a portfolio company and the holding entities above it. - WATERFALL_TARGET_TYPE_COMPANY: A single portfolio company. | | `created_after` | string | No | Only targets created at or after this time (UTC), to find new ones since your last sync. A target's `companyId`, feeder funds and names can change after it is created, so re-read the full list without this filter to refresh them. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Issuer Certificates **Slug:** `CARTA_LIST_ISSUER_CERTIFICATES` List one page of certificates belonging to the specified issuer, optionally filtered by last-modified time range. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `issuer_id` | string | Yes | The identifier of the issuer owning the certificates to retrieve. | | `page_size` | integer | No | The maximum number of certificates 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. | | `page_token` | string | No | A page token received as `nextPageToken` in a previous List Certificates response. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `certificates` must match the call that provided the page token. | | `last_modified_datetime_after` | string | No | Return certificates that were last modified on or after this date and time. Uses UTC and is specified in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), i.e. 'YYYY-MM-DDThh:mm:ssZ'. | | `last_modified_datetime_before` | string | No | Return certificates that were last modified on or before this date and time. Uses UTC and is specified in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), i.e. 'YYYY-MM-DDThh:mm:ssZ'. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Issuer Convertible Notes **Slug:** `CARTA_LIST_ISSUER_CONVERTIBLE_NOTES` List one page of convertible notes belonging to the specified issuer. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `issuer_id` | string | Yes | The identifier of the issuer owning the convertible notes to retrieve. | | `page_size` | integer | No | The maximum number of convertible notes to return. The service may return fewer than this value. If unspecified, at most 25 convertible notes will be returned. The maximum value is 50; values above 50 will be coerced to 50. | | `page_token` | string | No | A page token received as `nextPageToken` in a previous `ListConvertibleNotes` response. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConvertibleNotes` must match the call that provided the page token. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Issuer Fair Market Values **Slug:** `CARTA_LIST_ISSUER_FAIR_MARKET_VALUES` Retrieve the fair market values of an issuer, which are the values of the issuer's securities as determined by the issuer's 409a valuations. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `issuer_id` | string | Yes | The identifier of the issuer whose fair market values are being retrieved. | | `page_size` | integer | No | The maximum number of fair market values to return. The service may return fewer than this value. If unspecified, at most 25 fair market values will be returned. The maximum value is 50; values above 50 will be coerced to 50. | | `next_cursor` | string | No | A page token received as `nextPageToken` in a previous List Fair Market Values 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. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Issuer Interests **Slug:** `CARTA_LIST_ISSUER_INTERESTS` List one page of interests issued by the specified issuer, optionally as of a date. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `issuer_id` | string | Yes | The identifier of the issuer that issued the interests. | | `page_size` | integer | No | 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. | | `as_of_date` | string | No | Retrieves the interests as of the given date, specified as an [ISO 8601 extended format calendar date](https://en.wikipedia.org/wiki/ISO_8601#Calendar_dates), i.e. 'YYYY-MM-DD'. | | `next_cursor` | string | No | 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. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Issuer Option Exercises **Slug:** `CARTA_LIST_ISSUER_OPTION_EXERCISES` Retrieve one page of option exercises issued by an issuer. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `issuer_id` | string | Yes | Identifier of the issuer whose option exercises to retrieve. | | `page_size` | integer | No | Maximum option exercises to return. Carta defaults to 25 and coerces values above 100 to 100. | | `next_cursor` | string | No | Page token returned as next_cursor by a previous call. Keep all other query values unchanged. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Issuer Option Grants **Slug:** `CARTA_LIST_ISSUER_OPTION_GRANTS` List one page of option grants issued by the specified issuer, optionally filtered by last-modified time range. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `issuer_id` | string | Yes | The identifier of the issuer that issued the option grants to retrieve. | | `page_size` | integer | No | The maximum number of option grants 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. | | `page_token` | string | No | A page token received as `nextPageToken` in a previous List Option Grants response. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `optionGrants` must match the call that provided the page token. | | `last_modified_datetime_after` | string | No | Return option grants that were last modified on or after this date and time. Uses UTC and is specified in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), i.e. 'YYYY-MM-DDThh:mm:ssZ'. | | `last_modified_datetime_before` | string | No | Return option grants that were last modified on or before this date and time. Uses UTC and is specified in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), i.e. 'YYYY-MM-DDThh:mm:ssZ'. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Issuer Points Of Contact **Slug:** `CARTA_LIST_ISSUER_POINTS_OF_CONTACT` List the specified issuer's points of contact in a single response. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `issuer_id` | string | Yes | The identifier of the issuer whose points of contact are being retrieved. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Issuer Restricted Stock Awards **Slug:** `CARTA_LIST_ISSUER_RESTRICTED_STOCK_AWARDS` List one page of restricted stock awards issued by the specified issuer, optionally filtered by last-modified time range. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `issuer_id` | string | Yes | The identifier of the issuer owning the restricted stock awards to retrieve. | | `page_size` | integer | No | The maximum number of restricted stock awards 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. | | `page_token` | string | No | A page token received as `nextPageToken` in a previous List Restricted Stock Awards response. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `restrictedStockAwards` must match the call that provided the page token. | | `last_modified_datetime_after` | string | No | Return restricted stock awards that were last modified on or after this date and time. Uses UTC and is specified in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), i.e. 'YYYY-MM-DDThh:mm:ssZ'. | | `last_modified_datetime_before` | string | No | Return restricted stock awards that were last modified on or before this date and time. Uses UTC and is specified in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), i.e. 'YYYY-MM-DDThh:mm:ssZ'. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Issuer Restricted Stock Units **Slug:** `CARTA_LIST_ISSUER_RESTRICTED_STOCK_UNITS` List one page of restricted stock units issued by the specified issuer, optionally filtered by last-modified time range. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `issuer_id` | string | Yes | The identifier of the issuer owning the restricted stock units to retrieve. | | `page_size` | integer | No | 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. | | `page_token` | string | No | 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. | | `last_modified_datetime_after` | string | No | Return restricted stock units that were last modified on or after this date and time. Uses UTC and is specified in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), i.e. 'YYYY-MM-DDThh:mm:ssZ'. | | `last_modified_datetime_before` | string | No | Return restricted stock units that were last modified on or before this date and time. Uses UTC and is specified in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), i.e. 'YYYY-MM-DDThh:mm:ssZ'. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Issuers **Slug:** `CARTA_LIST_ISSUERS` List one page of issuers accessible to the connected account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page_size` | integer | No | 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. | | `next_cursor` | string | No | A page token received as `nextPageToken` in a previous List Issuers 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. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Issuer Share Classes **Slug:** `CARTA_LIST_ISSUER_SHARE_CLASSES` List one page of share classes issued by the specified issuer, optionally as of a date. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `issuer_id` | string | Yes | The identifier of the issuer that has issued the share classes to retrieve. | | `page_size` | integer | No | 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. | | `as_of_date` | string | No | Retrieve share classes as of the given date. Expected format for this date is [ISO 8601 complete calendar date](https://en.wikipedia.org/wiki/ISO_8601#Calendar_dates); i.e., 'YYYY-MM-DD' Retrieves share classes as of the given date, specified as an [ISO 8601 extended format calendar date](https://en.wikipedia.org/wiki/ISO_8601#Calendar_dates), i.e. 'YYYY-MM-DD'. | | `next_cursor` | string | No | A page token received as `nextPageToken` in a previous List Share Classes 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. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Issuer Stakeholders **Slug:** `CARTA_LIST_ISSUER_STAKEHOLDERS` List one page of stakeholders belonging to the specified issuer. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `issuer_id` | string | Yes | The identifier of the issuer owning the stakeholders to retrieve. | | `page_size` | integer | No | The maximum number of stakeholders to return. The service may return fewer than this value. If unspecified, at most 25 stakeholders will be returned. The maximum value is 100; values above 100 will be coerced to 100. | | `next_cursor` | string | No | A page token received as `nextPageToken` in a previous List Stakeholders 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. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Issuer Transactions **Slug:** `CARTA_LIST_ISSUER_TRANSACTIONS` List one page of transaction history for the specified issuer's securities, filtered by the required security type. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string ("option" | "rsu" | "rsa" | "certificate" | "warrant" | "convertible" | "piu" | "sar" | "phantom") | Yes | The security type to filter transactions by. Required. Supported values: - `option` — option grant transactions (issuance, exercises, cancellation) - `rsu` — restricted stock unit award transactions (issuance, settlements, cancellation) - `rsa` — restricted stock award transactions (issuance, cancellation) - `certificate` — certificate transactions (issuance, cancellation) - `warrant` — warrant transactions (issuance, exercises, transfers, cancellation) - `convertible` — convertible note transactions (issuance, cancellation) - `piu` — profits interest unit transactions (issuance, cancellation) - `sar` — stock appreciation right transactions (issuance, exercises, cancellation) - `phantom` — phantom equity transactions (issuance, cancellation) | | `issuer_id` | string | Yes | The identifier of the issuer whose transactions to retrieve. | | `page_size` | integer | No | The maximum number of securities (with their transactions) to return. The service may return fewer than this value. If unspecified, at most 50 securities will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. | | `page_token` | string | No | A page token received as `nextPageToken` in a previous response. Provide this to retrieve the subsequent page. When paginating, all other parameters must match the call that provided the page token. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Issuer Vesting Schedule Templates **Slug:** `CARTA_LIST_ISSUER_VESTING_SCHEDULE_TEMPLATES` List one page of vesting schedule templates belonging to the specified issuer. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `issuer_id` | string | Yes | The identifier of the issuer that has issued the share classes to retrieve. | | `page_size` | integer | No | 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. | | `next_cursor` | string | No | 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. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Portfolio Fund Investment Documents **Slug:** `CARTA_LIST_PORTFOLIO_FUND_INVESTMENT_DOCUMENTS` Retrieve one page of fund investment documents for a portfolio. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. | | `fund_id` | string | No | Return documents issued by this fund ID. | | `page_size` | integer | No | Maximum documents to return. Carta defaults to 25 and coerces values above 50 to 50. | | `portfolio_id` | string | Yes | ID of the portfolio whose fund investment documents to retrieve. | | `shared_date_after` | string | No | Return documents shared on or after this YYYY-MM-DD date. | | `shared_date_before` | string | No | Return documents shared on or before this YYYY-MM-DD date. | | `effective_date_after` | string | No | Return documents effective on or after this YYYY-MM-DD date. | | `effective_date_before` | string | No | Return documents effective on or before this YYYY-MM-DD date. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Portfolio Issuer Certificates **Slug:** `CARTA_LIST_PORTFOLIO_ISSUER_CERTIFICATES` List one page of certificates for the specified issuer within the specified portfolio, optionally filtered by last-modified time range. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `issuer_id` | string | Yes | The identifier of the issuer that has issued the certificates to retrieve. | | `page_size` | integer | No | The maximum number of certificates to return. The service may return fewer than this value. If unspecified, at most 25 certificates will be returned. The maximum value is 50; values above 50 will be coerced to 50. | | `page_token` | string | No | A page token received as `nextPageToken` in a previous List Certificates response. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `certificates` must match the call that provided the page token. | | `portfolio_id` | string | Yes | The identifier of the portfolio holding the certificates to retrieve. | | `last_modified_datetime_after` | string | No | Return certificates that were last modified on or after this date and time. Uses UTC and is specified in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), i.e. 'YYYY-MM-DDThh:mm:ssZ'. | | `last_modified_datetime_before` | string | No | Return certificates that were last modified on or before this date and time. Uses UTC and is specified in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), i.e. 'YYYY-MM-DDThh:mm:ssZ'. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Portfolio Issuer Convertible Notes **Slug:** `CARTA_LIST_PORTFOLIO_ISSUER_CONVERTIBLE_NOTES` List one page of convertible notes for the specified issuer within the specified portfolio. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `issuer_id` | string | Yes | The identifier of the issuer owning the convertible notes to retrieve. | | `page_size` | integer | No | The maximum number of convertible notes to return. The service may return fewer than this value. If unspecified, at most 25 convertible notes will be returned. The maximum value is 100; values above 100 will be coerced to 100. | | `page_token` | string | No | A page token received as `nextPageToken` in a previous `ListConvertibleNotes` response. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConvertibleNotes` must match the call that provided the page token. | | `portfolio_id` | string | Yes | The identifier of the portfolio holding the convertible note to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Portfolio Issuer Option Grants **Slug:** `CARTA_LIST_PORTFOLIO_ISSUER_OPTION_GRANTS` List one page of option grants for the specified issuer within the specified portfolio, optionally filtered by last-modified time range. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `issuer_id` | string | Yes | The identifier of the issuer that has issued the option grants to retrieve. | | `page_size` | integer | No | The maximum number of option grants to return. The service may return fewer than this value. If unspecified, at most 25 option grants will be returned. The maximum value is 50; values above 50 will be coerced to 50. | | `page_token` | string | No | A page token received as `nextPageToken` in a previous List Option Grants response. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `optionGrants` must match the call that provided the page token. | | `portfolio_id` | string | Yes | The identifier of the portfolio holding the option grants to retrieve. | | `last_modified_datetime_after` | string | No | Return option grants that were last modified on or after this date and time. Uses UTC and is specified in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), i.e. 'YYYY-MM-DDThh:mm:ssZ'. | | `last_modified_datetime_before` | string | No | Return option grants that were last modified on or before this date and time. Uses UTC and is specified in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), i.e. 'YYYY-MM-DDThh:mm:ssZ'. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Portfolio Issuer Restricted Stock Awards **Slug:** `CARTA_LIST_PORTFOLIO_ISSUER_RESTRICTED_STOCK_AWARDS` List one page of restricted stock awards for the specified issuer within the specified portfolio, optionally filtered by last-modified time range. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `issuer_id` | string | Yes | The identifier of the issuer that has issued the restricted stock awards to retrieve. | | `page_size` | integer | No | he maximum number of restricted stock awards to return. The service may return fewer than this value. If unspecified, at most 25 restricted stock awards will be returned. The maximum value is 50; values above 50 will be coerced to 50. | | `page_token` | string | No | A page token received as `nextPageToken` in a previous List Restricted Stock Awards response. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `restrictedStockAwards` must match the call that provided the page token. | | `portfolio_id` | string | Yes | The identifier of the portfolio holding the restricted stock awards to retrieve. | | `last_modified_datetime_after` | string | No | Return restricted stock awards that were last modified on or after this date and time. Uses UTC and is specified in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), i.e. 'YYYY-MM-DDThh:mm:ssZ'. | | `last_modified_datetime_before` | string | No | Return restricted stock awards that were last modified on or before this date and time. Uses UTC and is specified in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), i.e. 'YYYY-MM-DDThh:mm:ssZ'. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Portfolio Issuer Restricted Stock Units **Slug:** `CARTA_LIST_PORTFOLIO_ISSUER_RESTRICTED_STOCK_UNITS` List one page of restricted stock units for the specified issuer within the specified portfolio, optionally filtered by last-modified time range. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `issuer_id` | string | Yes | The identifier of the issuer that has issued the restricted stock units to retrieve. | | `page_size` | integer | No | The maximum number of restricted stock units to return. The service may return fewer than this value. If unspecified, at most 25 restricted stock units will be returned. The maximum value is 50; values above 50 will be coerced to 50. | | `page_token` | string | No | A page token, received from a previous `ListRestrictedStockUnits` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRestrictedStockUnits` must match the call that provided the page \ token. | | `portfolio_id` | string | Yes | The identifier of the portfolio holding the restricted stock units to retrieve. | | `last_modified_datetime_after` | string | No | Return restricted stock units that were last modified on or after this date and time. Uses UTC and is specified in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), i.e. 'YYYY-MM-DDThh:mm:ssZ'. | | `last_modified_datetime_before` | string | No | Return restricted stock units that were last modified on or before this date and time. Uses UTC and is specified in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), i.e. 'YYYY-MM-DDThh:mm:ssZ'. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Portfolio Issuers **Slug:** `CARTA_LIST_PORTFOLIO_ISSUERS` Retrieve one page of issuers in a shareholder portfolio. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. | | `page_size` | integer | No | Maximum issuers to return. Carta defaults to 25 and coerces values above 50 to 50. | | `portfolio_id` | string | Yes | Identifier of the portfolio whose issuers to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Portfolio Issuer Security Transactions **Slug:** `CARTA_LIST_PORTFOLIO_ISSUER_SECURITY_TRANSACTIONS` List one page of security transactions for the specified issuer within the specified portfolio. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `issuer_id` | string | Yes | The identifier of the issuer for which security transactions are to be retrieved. | | `page_size` | integer | No | The maximum number of security transactions to return. The service may return fewer than this value. If unspecified, at most 50 security transactions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. | | `page_token` | string | No | A URL-encoded page token received as `nextPageToken` in a previous List Security Transactions response. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `securityTransactions` must match the call that provided the page token. | | `portfolio_id` | string | Yes | The portfolio id of the portfolio for which security transactions are to be retrieved. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Portfolios **Slug:** `CARTA_LIST_PORTFOLIOS` Retrieve one page of shareholder portfolios. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. | | `page_size` | integer | No | Maximum portfolios to return. Carta defaults to 25 and coerces values above 50 to 50. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Issuer Money Movement **Slug:** `CARTA_UPDATE_ISSUER_MONEY_MOVEMENT` Update money movement information for an issuer option exercise. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `issuer_id` | string | Yes | Identifier of the issuer that issued the option exercise. | | `exercise_id` | string | Yes | Identifier of the option exercise to update. | | `money_movement` | object | No | Money movement information to update. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Issuer Tax Withholding **Slug:** `CARTA_UPDATE_ISSUER_TAX_WITHHOLDING` Update tax withholding information for an issuer option exercise. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `issuer_id` | string | Yes | Identifier of the issuer that issued the option exercise. | | `exercise_id` | string | Yes | Identifier of the option exercise to update. | | `tax_withholdings` | array | No | Tax withholding line items to update. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Upload File **Slug:** `CARTA_UPLOAD_FILE` Synchronously upload a generic file to Carta as a base64-encoded JSON payload. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file_payload` | object | Yes | File whose bytes Carta should upload. The payload must be between 1 and 3,670,016 bytes. | | `upload_details` | object | No | Optional name, description, and tags to preserve as file upload details. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Upload Open Cap Table **Slug:** `CARTA_UPLOAD_OPEN_CAP_TABLE` Upload an Open Cap Table Format package in binary form for Carta to process. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `extensions` | array | No | Application-specific metadata to preserve in the upload request. | | `content_type` | string | No | Content type of the uploaded OCF package. Omit it when the package has no declared media type. | | `open_cap_table_file` | object | No | Open Cap Table Format package file whose raw bytes Carta should process. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not |