Source: equa-server/modules/api/src/endpoints/captable-endpoints.ts
Cap Table Endpoints
Endpoints for managing an organization’s capitalization table including shareholdings, securities, option plans, pools, holdings, legends, valuations, vesting schedules, and certificates. All cap table endpoints require authentication. Most require RBAC permissions scoped to the organization.Shareholdings
Create Shareholding
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canEditCapTable |
Transfer Shares
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canEditCapTable |
List Shareholdings
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canViewCapitalizationOrSelf |
canViewCapitalizationOrSelf see their own holdings; users with full cap table access see all.
Get Shareholding
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canViewHolding |
Edit Shareholding
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canEditHolding |
Replace Shareholding
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canEditHolding |
Void Shareholding
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canEditHolding |
Get Shareholding Config
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canViewCapTable |
Get Shareholding Certificate
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canViewHolding |
Get Certificate Copy
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canViewHolding |
Securities
Create Security
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canEditCapTable |
Update Security
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canEditCapTable |
List Securities
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canViewOrganization |
Get Security
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canViewOrganization |
Delete Security
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canEditCapTable |
Add Shares to Security
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canEditCapTable |
Legends
Create Legend
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canEditCapTable |
List Legends
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canViewCapTable |
Get Legend
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canViewCapTable |
Update Legend
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canEditCapTable |
Delete Legend
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canEditCapTable |
Get Legend Certificate
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canViewCapTable |
Option Plans
Create Plan
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canEditCapTable |
List Plans
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canViewOrganization |
Get Plan
| Field | Value |
|---|---|
| Auth | Required |
Update Plan
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canEditPlan |
Delete Plan
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canEditPlan |
Get Plan Dashboard
| Field | Value |
|---|---|
| Auth | Required |
Pools and Options
List Pool Options
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canViewPool |
Get Option (Nested)
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canViewOptionOld |
Get Option
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canViewOption |
List Organization Options
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canViewOrganization |
Get Member Options
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canViewMember |
Exercise Option
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canEditExerciseOption |
Request Option Exercise
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canEditExerciseOption |
Holdings
Create Holding
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canEdit |
Update Holding
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canEditHolding |
Patch Holding
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canEditHolding |
List Holdings
| Field | Value |
|---|---|
| Auth | Required |
Get Holding
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canViewHolding |
Delete Holding
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canEditHolding |
Repay Holding
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canEditHolding |
Convert Holding
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canEditHolding |
Capital Changes
Create Capital Change
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canEdit |
Edit Capital Contributions
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canEdit |
Valuations
Create/Update Valuation
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canEdit |
List Valuations
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canViewCapTable |
Get Valuation
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canViewValuation |
Vesting Schedules
Create Vesting Schedule
| Field | Value |
|---|---|
| Auth | Required |
Update Vesting Schedule
| Field | Value |
|---|---|
| Auth | Required |
Delete Vesting Schedule
| Field | Value |
|---|---|
| Auth | Required |
Get Vesting Schedule
| Field | Value |
|---|---|
| Auth | Required |
List Vesting Schedules
| Field | Value |
|---|---|
| Auth | Required |
Project Vesting Schedule
| Field | Value |
|---|---|
| Auth | Required |
Utility
Get Blocks
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canViewCapitalizationOrSelf |
Get Incentive Documents
| Field | Value |
|---|---|
| Auth | Required |
Export Cap Table
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canViewCapTable |
Get Cap Table Dashboard
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canViewOrganization |
Get Cap Table Pools
| Field | Value |
|---|---|
| Auth | Required |
| Permission | canViewOrganization |
Get Entity Profile Portfolio
| Field | Value |
|---|---|
| Auth | Required |
Import CSV
| Field | Value |
|---|---|
| Auth | Required |
Multi-Query
| Field | Value |
|---|---|
| Auth | Required |