Shareworks · Controlled Vocabulary
Shareworks Vocabulary
Domain vocabulary for equity compensation management on the Shareworks platform
93 Terms
Updated
Shareworks Vocabulary is a controlled vocabulary published by Shareworks on the APIs.io network, defining 93 terms.
Defined terms include Authentication Token, Authorized Capital, Award Type, Company, and Company Board.
A controlled vocabulary pins the words an API’s schemas, parameters and documentation use to one agreed definition each — the shared language a human or an agent needs to read the API the same way its authors do.
Terms
Authentication Token
JWT bearer token used to authenticate API requests via RS256 signing
Authorized Capital
Total shares a company is authorized to issue under its charter
Award Type
Category of equity award such as stock options, RSUs, or ESPP
Company
Legal entity managing equity compensation plans on the Shareworks platform
Company Board
Board of directors appointments and governance records for a company
Company Integration
Third-party system integration configuration for a company
Entity Stakeholder
Non-individual legal entity holding equity such as a trust or corporation
Grant
Award of equity compensation issued to a stakeholder
Holdings
Aggregate equity position held by a stakeholder across all grants
Individual Stakeholder
A natural person who holds or may hold equity in a company
Plan
Equity compensation plan defining award rules, pool sizes, and eligibility
Read Access
API permission level allowing retrieval of data without modification
Stock Certificate
Legal instrument representing ownership of shares
Stock Filing
Regulatory filing related to stock issuance or capitalization
Vesting Schedule
Timeline defining when equity awards become exercisable or deliverable
Write Access
API permission level allowing creation or modification of data
AccessToken
Token to accompany all API requests for authentication purposes
AccessTokenRequest
Data model for AccessTokenRequest in the Shareworks API
AccessTokenResponse
Data model for AccessTokenResponse in the Shareworks API
AccessTokenWrapper
Data model for AccessTokenWrapper in the Shareworks API
AuthorizedCapitalDetails
Data model for AuthorizedCapitalDetails in the Shareworks API
AwardTypeDetails
Data model for AwardTypeDetails in the Shareworks API
ClassOfSecuritiesDetails
Data model for ClassOfSecuritiesDetails in the Shareworks API
ClassOfSecuritiesSummaryDetails
List of summary information for all classes of securities for the company
CompanyAddressCrudRequest
List of up to three company addresses
CompanyAddressDetails
List of up to three company addresses
CompanyBoardAppointmentCreateCrudRequest
Data model for CompanyBoardAppointmentCreateCrudRequest in the Shareworks API
CompanyBoardAppointmentDetails
Data model for CompanyBoardAppointmentDetails in the Shareworks API
CompanyBoardAppointmentUpdateCrudRequest
Data model for CompanyBoardAppointmentUpdateCrudRequest in the Shareworks API
CompanyBoardCrudRequest
Data model for CompanyBoardCrudRequest in the Shareworks API
CompanyBoardDetails
Data model for CompanyBoardDetails in the Shareworks API
CompanyBoardDetailsWithAppointments
Data model for CompanyBoardDetailsWithAppointments in the Shareworks API
CompanyContactCrudRequest
List of all company contacts
CompanyContactDetails
List of all company contacts
CompanyCrudRequest
Data model for CompanyCrudRequest in the Shareworks API
CompanyDetails
Data model for CompanyDetails in the Shareworks API
CompanyIntegrationDetails
Data model for CompanyIntegrationDetails in the Shareworks API
CompanyIntegrationRequest
Data model for CompanyIntegrationRequest in the Shareworks API
DesignatedSharesSummaryDetails
Summary of all shares across the stock designations for the class
EntityStakeholderCrudRequest
Data model for EntityStakeholderCrudRequest in the Shareworks API
EntityStakeholderDetails
Data model for EntityStakeholderDetails in the Shareworks API
EntityStakeholderSearchRequest
Data model for EntityStakeholderSearchRequest in the Shareworks API
ErrorWithCode
Data model for ErrorWithCode in the Shareworks API
FundDetails
Data model for FundDetails in the Shareworks API
IndividualStakeholderCrudRequest
Data model for IndividualStakeholderCrudRequest in the Shareworks API
IndividualStakeholderDetails
Data model for IndividualStakeholderDetails in the Shareworks API
IndividualStakeholderSearchRequest
Data model for IndividualStakeholderSearchRequest in the Shareworks API
ManualVestingRowCrudRequest
List of all manual vesting rows for the grant, specified when using a manual vesting schedule
ManualVestingRowDetails
List of all manual vesting rows for the grant, specified when using a manual vesting schedule
ManualVestingScheduleDetails
Data model for ManualVestingScheduleDetails in the Shareworks API
PlanSummaryDetails
List of summary information for all plans for the company
PlanSummaryDetailsWithGrants
Data model for PlanSummaryDetailsWithGrants in the Shareworks API
RestApiErrorResponse
Data model for RestApiErrorResponse in the Shareworks API
SecuritiesDesignationDetails
Data model for SecuritiesDesignationDetails in the Shareworks API
SharePoolPlanCreationRequest
Data model for SharePoolPlanCreationRequest in the Shareworks API
SharePoolPlanDetails
Data model for SharePoolPlanDetails in the Shareworks API
StakeholderGrantAcceleratedVestingCrudRequest
(Optional) List of the vesting acceleration stipulations of the grant. May be empty. Include one stipulation per trigger that is applicable.
StakeholderGrantAcceleratedVestingDetails
List of the vesting acceleration stipulations of the grant. May be empty.
StakeholderGrantCrudRequest
Data model for StakeholderGrantCrudRequest in the Shareworks API
StakeholderGrantDetails
Data model for StakeholderGrantDetails in the Shareworks API
StakeholderGrantSummaryDetails
List of grants held by the stakeholder
StakeholderHoldingsDetails
List of all stakeholder holdings (excepting warrants and convertible promissory notes, as yet unsupported)
StakeholderHoldingsSummaryDetails
Data model for StakeholderHoldingsSummaryDetails in the Shareworks API
StockCertificateCrudRequest
Data model for StockCertificateCrudRequest in the Shareworks API
StockCertificateDetails
Data model for StockCertificateDetails in the Shareworks API
StockCertificateSummaryDetails
List of stock certificates held by the stakeholder
StockFilingClassDetails
List of all classes of securities for the stock filing
StockFilingDesignationDetails
List of all stock designations for the class of securities
StockFilingDetails
Data model for StockFilingDetails in the Shareworks API
StockFilingWithNewDesignationCreationRequest
Data model for StockFilingWithNewDesignationCreationRequest in the Shareworks API
VestingScheduleCrudRequest
Data model for VestingScheduleCrudRequest in the Shareworks API
VestingScheduleDetails
Data model for VestingScheduleDetails in the Shareworks API
VestingScheduleRowDetails
List of all rows/tranches for the vesting schedule
VestingScheduleRowRequest
List of all rows/tranches for the vesting schedule
WarrantsSummaryDetails
Summary information on warrants for the company
WrappedCollectionAwardTypeDetails
Data model for WrappedCollectionAwardTypeDetails in the Shareworks API
WrappedCollectionFundDetails
Data model for WrappedCollectionFundDetails in the Shareworks API
WrappedCollectionManualVestingScheduleDetails
Data model for WrappedCollectionManualVestingScheduleDetails in the Shareworks API
WrappedCollectionSecuritiesDesignationDetails
Data model for WrappedCollectionSecuritiesDesignationDetails in the Shareworks API
WrappedCollectionStakeholderHoldingsSummaryDetails
Data model for WrappedCollectionStakeholderHoldingsSummaryDetails in the Shareworks API
WrappedDataAuthorizedCapitalDetails
Data model for WrappedDataAuthorizedCapitalDetails in the Shareworks API
WrappedDataClassOfSecuritiesDetails
Data model for WrappedDataClassOfSecuritiesDetails in the Shareworks API
WrappedDataCompanyBoardAppointmentDetails
Data model for WrappedDataCompanyBoardAppointmentDetails in the Shareworks API
WrappedDataCompanyBoardDetailsWithAppointments
Data model for WrappedDataCompanyBoardDetailsWithAppointments in the Shareworks API
WrappedDataCompanyDetails
Data model for WrappedDataCompanyDetails in the Shareworks API
WrappedDataEntityStakeholderDetails
Data model for WrappedDataEntityStakeholderDetails in the Shareworks API
WrappedDataIndividualStakeholderDetails
Data model for WrappedDataIndividualStakeholderDetails in the Shareworks API
WrappedDataPlanSummaryDetailsWithGrants
Data model for WrappedDataPlanSummaryDetailsWithGrants in the Shareworks API
WrappedDataStakeholderGrantDetails
Data model for WrappedDataStakeholderGrantDetails in the Shareworks API
WrappedDataStakeholderHoldingsSummaryDetails
Data model for WrappedDataStakeholderHoldingsSummaryDetails in the Shareworks API
WrappedDataStockCertificateDetails
Data model for WrappedDataStockCertificateDetails in the Shareworks API
WrappedDataStockFilingDetails
Data model for WrappedDataStockFilingDetails in the Shareworks API
WrappedDataVestingScheduleDetails
Data model for WrappedDataVestingScheduleDetails in the Shareworks API
Controlled Vocabulary
Work with this as data
Every vocabulary here is available over the APIs.io API and to AI agents over MCP. Vocabularies is not yet its own endpoint on the v1 API. Reach it through catalog search and the tag graph, or the MCP server.