Carta's API uses Oauth scopes to control access to our data. Our scopes follow this pattern:
read_{package_and_resource}: Grants read-only access to endpoints.
readwrite_{package_and_resource}: Grants read & modify access to endpoints.
The package_and_resource parts of the scope names exist to logically group OAuth scopes together. This largely follows the structure of the HTTP paths of our endpoints.
For example, the scope read_issuer_securities grants read-only access to the /issuers/{issuer_id}/optionGrant endpoint, which deals with issuer's option grants, a type of security.
📘Your application's access to Carta data will match the user who granted you that access. For example, when you submit a call to our Issuer API, we verify the user's current role to confirm they still have appropriate access. Note that company administrators can freely change their users' roles, and if you attempt to access the API after the user no longer has appropriate access we will respond with a 403 Forbidden error with reason MISSING_INTERNAL_PERMISSION. See Permissions and Roles for more information about Carta's account roles.
| Scope | Description |
|---|
read_compensation_benchmarks | Read compensation benchmarking data from Carta Total Comp. |
| Scope | Description |
|---|
read_corporation_info | Read corporation details such as name, description, and website. |
| Scope | Description |
|---|
readwrite_draftissuers | Read and write details about a draft issuer to Carta Launch. |
read_draftissuers | Read details about a draft issuer from Carta Launch. |
| Scope | Description |
|---|
readwrite_file_upload | Perform a file upload and read corresponding data. |
| Scope | Description |
|---|
read_issuer_info | Read issuer details such as name, description, and website. |
read_issuer_draftsecurities | Read details of issuer draft securities such as draft option grants. |
read_issuer_securities | Read details of issuer securities such as options, RSUs, RSAs, and certificates. |
read_issuer_interests | Read details of issuer interests for LLC issuers. |
read_issuer_securitiestemplates | Read details of issuer securities templates such as vesting schedules, performance conditions, and acceleration terms. |
read_issuer_shareclasses | Read share class information about an issuer. |
read_issuer_stakeholders | Read details about stakeholders who have received equity from an issuer. |
read_issuer_valuations | Read valuation information about an issuer. |
read_issuer_capitalizationtablesummary | Read the summary capitalization tables of issuers. |
read_issuer_stakeholdercapitalizationtable | Read stakeholder-level capitalization table information about an issuer. |
readwrite_issuer_draftsecurities | Read and write to the issuer's draft securities such as draft option grants. |
readwrite_issuer_securities | Read and write to the issuer's securities such as options, RSUs, RSAs, and certificates. |
| Scope | Description |
|---|
read_investor_capitalizationtables | Read the summary capitalization tables of investor investments. |
read_investor_cashbalances | Read information about cash balances for funds in a firm. |
read_investor_investments | Read information about investor investments. |
read_investor_firms | Read information about investor firms. |
read_investor_funds | Read information about investor funds. |
read_investor_fundperformance | Read information about investor fund performance metrics. |
read_investor_partners | Read information about partners in funds in an investment firm. |
read_investor_securities | Read information about securities in an investment firm. |
read_investor_stakeholdercapitalizationtable | Read stakeholder-level capitalization table information about an investment company. |
| Scope | Description |
|---|
read_opencaptables | Read information about open cap tables. |
readwrite_opencaptables | Read and write information about open cap tables. |
| Scope | Description |
|---|
read_portfolio_info | Read information about a portfolio such as profile information. |
read_portfolio_securities | Read information about securities in a portfolio (i.e. holdings). |
read_portfolio_transactions | Read information about a portfolio's security transactions. |
read_portfolio_issuervaluations | Read valuation information for issuers within a portfolio. |
read_portfolio_fundinvestmentdocuments | Read fund investment documents from a portfolio. |
| Scope | Description |
|---|
read_user_info | Read information about the current user such as id, name, and email address. |
We also support three additional scopes related to user information noted below. See the OpenID Connect Basic Client Implementer's Guide for more information on these scopes:
| Scope | Description |
|---|
openid | An OpenID Connect scope to access the User Info endpoint. |
profile | An OpenID Connect scope which returns common fields in the id_token. |
email | An OpenID Connect scope which returns email related fields in the id_token. |
