Carta

App · 19 actions

Read company equity, stakeholders, securities, transactions, investment firms and funds.

Actions

ActionWhat it does
Corporations list corporationsCorporations list corporations in Carta.
Get current userGet current user in Carta.
Investor list capitalization tablesInvestor list capitalization tables in Carta.
Investor list certificatesInvestor list certificates in Carta.
Investor list firmsInvestor list firms in Carta.
Investor list fundsInvestor list funds in Carta.
Investor list investmentsInvestor list investments in Carta.
Investor list partner contactsInvestor list partner contacts in Carta.
Issuer get capitalization tableIssuer get capitalization table in Carta.
Issuer get stakeholderIssuer get stakeholder in Carta.
Issuer list certificatesIssuer list certificates in Carta.
Issuer list convertible notesIssuer list convertible notes in Carta.
Issuer list interestsIssuer list interests in Carta.
Issuer list issuersIssuer list issuers in Carta.
Issuer list option exercisesIssuer list option exercises in Carta.
Issuer list option grantsIssuer list option grants in Carta.
Issuer list stakeholdersIssuer list stakeholders in Carta.
Issuer list transactionsIssuer list transactions in Carta.
Issuer list vesting schedule templatesIssuer list vesting schedule templates in Carta.

Corporations list corporations

Corporations list corporations in Carta.

Inputs

Page sizepage_sizenumber
The maximum number of corporations to return. The service may return fewer than this value. If unspecified, at most 25 corporations will be returned. The maximum value is 50; values above 50 will be coerced to 50.
Page tokenpage_tokentext
A page token received as `nextPageToken` in a previous List Corporations 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.

Outputs

dataobject
The response for the ListCorporations endpoint.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": {
    "corporations": [],
    "nextPageToken": "example"
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}

Get current user

Get current user in Carta.

Inputs

None.

Outputs

dataobject
The response for the GetCurrentUser endpoint.
Example output
{
  "data": {
    "user": {
      "email": "example",
      "firstName": "example",
      "id": "example",
      "lastName": "example"
    }
  }
}

Investor list capitalization tables

Investor list capitalization tables in Carta.

Inputs

Firmfirm_idtextRequired
The identifier of the firm.
Fundfund_idtextRequired
The identifier of the fund.
Companycompany_idtextRequired
The identifier of the investment company.
Page sizepage_sizenumber
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.
Page tokenpage_tokentext
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.

Outputs

dataobject
The response from the List Capitalization Tables endpoint.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": {
    "capitalizationTables": [],
    "nextPageToken": "example"
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}

Investor list certificates

Investor list certificates in Carta.

Inputs

Firmfirm_idtextRequired
The identifier of the firm.
Fundfund_idtextRequired
The identifier of the fund or `-` to list certificates across all funds under the firm specified by `firmId`.
Investment IDinvestment_idtextRequired
The identifier of the investment or `-` to list certificates across all company investments under the fund specified by `firmId` and `fundId`.
As of dateas_of_datetext
*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 sizepage_sizenumber
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.
Page tokenpage_tokentext
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.
Last modified datetime afterlast_modified_datetime_aftertext
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 beforelast_modified_datetime_beforetext
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'.

Outputs

dataobject
The response from the `ListCertificates` endpoint.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": {
    "certificates": [],
    "nextPageToken": "example"
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}

Investor list firms

Investor list firms in Carta.

Inputs

Page sizepage_sizenumber
The maximum number of firms to return. The service may return fewer than this value. If unspecified, at most 25 firms will be returned. The maximum value is 50; values above 50 will be coerced to 50.
Page tokenpage_tokentext
The page token received in a previous List Firms response. Submit this token to retrieve the subsequent page. When paginating, all other parameters provided to `ListFirms` must match the call that received the page token.

Outputs

dataobject
The response from the List Firms endpoint.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": {
    "firms": [],
    "nextPageToken": "example"
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}

Investor list funds

Investor list funds in Carta.

Inputs

Firmfirm_idtextRequired
The identifier of the firm holding the funds.
Page sizepage_sizenumber
The maximum number of funds 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 tokenpage_tokentext
The page token received from a previous List Funds call. Provide this token to retrieve the subsequent page. When paginating, all other parameters provided to `funds` must match the call that received the page token.

Outputs

dataobject
The response from the List Funds endpoint.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": {
    "funds": [],
    "nextPageToken": "example"
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}

Investor list investments

Investor list investments in Carta.

Inputs

Firmfirm_idtextRequired
The identifier of the firm.
Fundfund_idtextRequired
The identifier of the fund.
Page sizepage_sizenumber
The maximum number of items 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 tokenpage_tokentext
The page token received from a previous call to this same endpoint. Provide this token to retrieve the subsequent page. When paginating, all other parameters provided must match those used in the call that received the page token.

Outputs

dataobject
The response from the List Investments endpoint.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": {
    "investments": [],
    "nextPageToken": "example"
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}

Investor list partner contacts

Investor list partner contacts in Carta.

Inputs

Firmfirm_idtextRequired
The firm ID for which to retrieve partner contacts.
Fund IDsfund_idstext
Comma-separated fund IDs to filter contacts by. If unspecified, returns contacts across all funds.
Partner IDspartner_idstext
Comma-separated partner IDs to filter contacts by. If unspecified, returns contacts for all partners.
Page sizepage_sizenumber
The maximum number of contacts to return. The service may return fewer than this value. If unspecified, at most 50 contacts will be returned. The maximum value is 100; values above 100 will be coerced to 100.
Page tokenpage_tokentext
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.

Outputs

dataobject
Response message for listing partner contacts.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": {
    "nextPageToken": "example",
    "partnerContacts": []
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}

Issuer get capitalization table

Issuer get capitalization table in Carta.

Inputs

Issuerissuer_idtextRequired
The identifier of the issuer.
As of dateas_of_datetext
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'.

Outputs

dataobject
The response from the Get Capitalization Table endpoint.
Example output
{
  "data": {
    "capitalizationTable": {
      "asOfDate": {
        "value": "example"
      },
      "issuerId": "example",
      "noteBlockSummaries": [],
      "optionPoolSummaries": [],
      "shareClassSummaries": [],
      "summary": {
        "cashRaised": {
          "amount": {
            "value": "example"
          },
          "currencyCode": {
            "value": "example"
          }
        },
        "companyFullyDilutedShares": {
          "value": "example"
        },
        "companyOutstandingShares": {
          "value": "example"
        },
        "fullyDilutedShares": {
          "value": "example"
        },
        "outstandingShares": {
          "value": "example"
        }
      },
      "warrantBlockSummaries": []
    }
  }
}

Issuer get stakeholder

Issuer get stakeholder in Carta.

Inputs

Issuerissuer_idtextRequired
The identifier of the issuer owning the stakeholder to retrieve.
IdidtextRequired
The identifier of the stakeholder to retrieve.

Outputs

dataobject
The response from the Get Stakeholder endpoint.
Example output
{
  "data": {
    "stakeholder": {
      "address": {
        "country": "example"
      },
      "email": "example",
      "employeeId": "example",
      "entityType": "INDIVIDUAL",
      "fullName": "example",
      "group": "example",
      "id": "example",
      "issuerId": "example",
      "relationship": "ADVISOR"
    }
  }
}

Issuer list certificates

Issuer list certificates in Carta.

Inputs

Issuerissuer_idtextRequired
The identifier of the issuer owning the certificates to retrieve.
Page sizepage_sizenumber
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 tokenpage_tokentext
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 afterlast_modified_datetime_aftertext
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 beforelast_modified_datetime_beforetext
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'.

Outputs

dataobject
The response from the List Certificates endpoint.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": {
    "certificates": [],
    "nextPageToken": "example"
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}

Issuer list convertible notes

Issuer list convertible notes in Carta.

Inputs

Issuerissuer_idtextRequired
The identifier of the issuer owning the convertible notes to retrieve.
Page sizepage_sizenumber
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 tokenpage_tokentext
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.

Outputs

dataobject
The response from the `ListConvertibleNotes` endpoint.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": {
    "convertibleNotes": [],
    "nextPageToken": "example"
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}

Issuer list interests

Issuer list interests in Carta.

Inputs

Issuerissuer_idtextRequired
The identifier of the issuer that issued the interests.
As of dateas_of_datetext
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'.
Page sizepage_sizenumber
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.
Page tokenpage_tokentext
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.

Outputs

dataobject
The response from the List Interests endpoint.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": {
    "asOfDate": {
      "value": "example"
    },
    "interests": [],
    "nextPageToken": "example"
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}

Issuer list issuers

Issuer list issuers in Carta.

Inputs

Page sizepage_sizenumber
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.
Page tokenpage_tokentext
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.

Outputs

dataobject
The response for the ListIssuers endpoint.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": {
    "issuers": [],
    "nextPageToken": "example"
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}

Issuer list option exercises

Issuer list option exercises in Carta.

Inputs

Issuerissuer_idtextRequired
The identifier of the issuer that issued the option exercises to retrieve.
Page sizepage_sizenumber
The maximum number of option exercises to return. The service may return fewer than this value. If unspecified, at most 25 option exercises will be returned. The maximum value is 100; values above 100 will be coerced to 100.
Page tokenpage_tokentext
A page token received as `nextPageToken` in a previous List Option Exercises 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.

Outputs

dataobject
The response for the ListOptionExercises endpoint.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": {
    "nextPageToken": "example",
    "optionExercises": []
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}

Issuer list option grants

Issuer list option grants in Carta.

Inputs

Issuerissuer_idtextRequired
The identifier of the issuer that issued the option grants to retrieve.
Page sizepage_sizenumber
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 tokenpage_tokentext
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 afterlast_modified_datetime_aftertext
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 beforelast_modified_datetime_beforetext
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'.

Outputs

dataobject
The response for the ListOptionGrants endpoint.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": {
    "nextPageToken": "example",
    "optionGrants": []
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}

Issuer list stakeholders

Issuer list stakeholders in Carta.

Inputs

Issuerissuer_idtextRequired
The identifier of the issuer owning the stakeholders to retrieve.
Page sizepage_sizenumber
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.
Page tokenpage_tokentext
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.

Outputs

dataobject
The response from the List Stakeholders endpoint.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": {
    "nextPageToken": "example",
    "stakeholders": []
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}

Issuer list transactions

Issuer list transactions in Carta.

Inputs

Issuerissuer_idtextRequired
The identifier of the issuer whose transactions to retrieve.
Page sizepage_sizenumber
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 tokenpage_tokentext
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.
TypetypetextRequired
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)One of: option, rsu, rsa, certificate, warrant, convertible, piu, sar, phantom.

Outputs

dataobject
The response from the List Transactions endpoint. Exactly one transaction array is populated per request, determined by the `type` query parameter. For example, `type=option` populates `optionTransactions` only; the other arrays will be empty.
Example output
{
  "data": {
    "certificateTransactions": [],
    "convertibleTransactions": [],
    "nextPageToken": "example",
    "optionTransactions": [],
    "phantomTransactions": [],
    "piuTransactions": [],
    "rsaTransactions": [],
    "rsuTransactions": [],
    "sarTransactions": [],
    "warrantTransactions": []
  }
}

Issuer list vesting schedule templates

Issuer list vesting schedule templates in Carta.

Inputs

Issuerissuer_idtextRequired
The identifier of the issuer that has issued the share classes to retrieve.
Page sizepage_sizenumber
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.
Page tokenpage_tokentext
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.

Outputs

dataobject
The response for the ListVestingScheduleTemplates endpoint.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": {
    "nextPageToken": "example",
    "vestingScheduleTemplates": []
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}

On this page