Skip to main content
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

POST /v1/organization/:organization/shareholding
FieldValue
AuthRequired
PermissioncanEditCapTable
Create a new shareholding. Automatically updates the Chargify shareholder count.

Transfer Shares

POST /v1/organization/:organization/shareholding/transfer
FieldValue
AuthRequired
PermissioncanEditCapTable
Transfer shares between members. Updates the Chargify shareholder count.

List Shareholdings

GET /v1/organization/:organization/shareholding
FieldValue
AuthRequired
PermissioncanViewCapitalizationOrSelf
List all shareholdings for an organization. Users with canViewCapitalizationOrSelf see their own holdings; users with full cap table access see all.

Get Shareholding

GET /v1/shareholding/:holding
FieldValue
AuthRequired
PermissioncanViewHolding

Edit Shareholding

PATCH /v1/shareholding/:holding
FieldValue
AuthRequired
PermissioncanEditHolding

Replace Shareholding

PUT /v1/shareholding/:holding
FieldValue
AuthRequired
PermissioncanEditHolding

Void Shareholding

DELETE /v1/shareholding/:holding
FieldValue
AuthRequired
PermissioncanEditHolding
Void (soft delete) a shareholding. Updates the Chargify shareholder count.

Get Shareholding Config

GET /v1/organization/:organization/shareholding/config
FieldValue
AuthRequired
PermissioncanViewCapTable
Get shareholding configuration (operating agreement settings).

Get Shareholding Certificate

GET /v1/shareholding/:holding/certificate
FieldValue
AuthRequired
PermissioncanViewHolding
Generate and download a share certificate PDF.

Get Certificate Copy

GET /v1/shareholding/:holding/certificate/copy
FieldValue
AuthRequired
PermissioncanViewHolding
Generate a copy of the share certificate.

Securities

Create Security

POST /v1/organization/:organization/security
FieldValue
AuthRequired
PermissioncanEditCapTable

Update Security

PUT /v1/organization/:organization/security/:security
FieldValue
AuthRequired
PermissioncanEditCapTable

List Securities

GET /v1/organization/:organization/security
FieldValue
AuthRequired
PermissioncanViewOrganization

Get Security

GET /v1/organization/:organization/security/:security
FieldValue
AuthRequired
PermissioncanViewOrganization

Delete Security

DELETE /v1/organization/:organization/security/:security
FieldValue
AuthRequired
PermissioncanEditCapTable

Add Shares to Security

POST /v1/organization/:organization/security/:security/shares
FieldValue
AuthRequired
PermissioncanEditCapTable
Add authorized shares to a security type.

Legends

Create Legend

POST /v1/organization/:organization/legend
FieldValue
AuthRequired
PermissioncanEditCapTable

List Legends

GET /v1/organization/:organization/legend
FieldValue
AuthRequired
PermissioncanViewCapTable

Get Legend

GET /v1/organization/:organization/legend/:legend
FieldValue
AuthRequired
PermissioncanViewCapTable

Update Legend

PATCH /v1/organization/:organization/legend/:legend
FieldValue
AuthRequired
PermissioncanEditCapTable

Delete Legend

DELETE /v1/organization/:organization/legend/:legend
FieldValue
AuthRequired
PermissioncanEditCapTable

Get Legend Certificate

GET /v1/organization/:organization/legend/:legend/certificate
FieldValue
AuthRequired
PermissioncanViewCapTable

Option Plans

Create Plan

POST /v1/organization/:organization/plan
FieldValue
AuthRequired
PermissioncanEditCapTable

List Plans

GET /v1/organization/:organization/plan
FieldValue
AuthRequired
PermissioncanViewOrganization

Get Plan

GET /v1/plan/:plan
FieldValue
AuthRequired

Update Plan

PUT /v1/plan/:plan
FieldValue
AuthRequired
PermissioncanEditPlan

Delete Plan

DELETE /v1/plan/:plan
FieldValue
AuthRequired
PermissioncanEditPlan
Deletes a plan and updates the Chargify member count.

Get Plan Dashboard

GET /v1/plan/:plan/dashboard
FieldValue
AuthRequired
Get dashboard summary data for an option plan.

Pools and Options

List Pool Options

GET /v1/plan/:plan/pool/:pool/option
FieldValue
AuthRequired
PermissioncanViewPool

Get Option (Nested)

GET /v1/plan/:plan/pool/:pool/option/:option
Deprecated. Use GET /v1/option/:option instead. This endpoint will be removed in a future API version.
FieldValue
AuthRequired
PermissioncanViewOptionOld

Get Option

GET /v1/option/:option
FieldValue
AuthRequired
PermissioncanViewOption

List Organization Options

GET /v1/organization/:organization/option
FieldValue
AuthRequired
PermissioncanViewOrganization

Get Member Options

GET /v1/member/:member/options
FieldValue
AuthRequired
PermissioncanViewMember

Exercise Option

POST /v1/plan/:plan/pool/:pool/option/:option/exercise
FieldValue
AuthRequired
PermissioncanEditExerciseOption

Request Option Exercise

POST /v1/plan/:plan/pool/:pool/option/:option/exercise/request
FieldValue
AuthRequired
PermissioncanEditExerciseOption

Holdings

Create Holding

POST /v1/holding
FieldValue
AuthRequired
PermissioncanEdit
Create a new holding (option grant, convertible note, SAFE, etc.). Updates the Chargify member count.

Update Holding

PUT /v1/holding/:holding
FieldValue
AuthRequired
PermissioncanEditHolding

Patch Holding

PATCH /v1/holding/:holding
FieldValue
AuthRequired
PermissioncanEditHolding

List Holdings

GET /v1/holding
FieldValue
AuthRequired
List holdings for the authenticated user’s entities.

Get Holding

GET /v1/holding/:holding
FieldValue
AuthRequired
PermissioncanViewHolding

Delete Holding

DELETE /v1/holding/:holding
FieldValue
AuthRequired
PermissioncanEditHolding

Repay Holding

POST /v1/holding/:holding/repay
FieldValue
AuthRequired
PermissioncanEditHolding
Record a repayment against a debt holding (convertible note).

Convert Holding

POST /v1/holding/:holding/convert
FieldValue
AuthRequired
PermissioncanEditHolding
Convert a holding (e.g., SAFE or convertible note) into equity.

Capital Changes

Create Capital Change

POST /v1/entity/:entity/capitalChange
FieldValue
AuthRequired
PermissioncanEdit

Edit Capital Contributions

PATCH /v1/entity/:entity/capitalChange
FieldValue
AuthRequired
PermissioncanEdit

Valuations

Create/Update Valuation

PUT /v1/valuation
FieldValue
AuthRequired
PermissioncanEdit

List Valuations

GET /v1/organization/:organization/valuation
FieldValue
AuthRequired
PermissioncanViewCapTable

Get Valuation

GET /v1/valuation/:valuation
FieldValue
AuthRequired
PermissioncanViewValuation

Vesting Schedules

Create Vesting Schedule

POST /v1/vestingSchedule
FieldValue
AuthRequired

Update Vesting Schedule

PUT /v1/vestingSchedule/:vestingScheduleOld
FieldValue
AuthRequired

Delete Vesting Schedule

DELETE /v1/plan/:plan/vestingSchedule/:vestingSchedule
FieldValue
AuthRequired

Get Vesting Schedule

GET /v1/vestingSchedule/:vestingSchedule
FieldValue
AuthRequired

List Vesting Schedules

GET /v1/vestingSchedule
FieldValue
AuthRequired

Project Vesting Schedule

POST /v1/schedule/project
FieldValue
AuthRequired
Project/preview a vesting schedule calculation without saving.

Utility

Get Blocks

GET /v1/organization/:organization/block
FieldValue
AuthRequired
PermissioncanViewCapitalizationOrSelf

Get Incentive Documents

GET /v1/incentive/documents
FieldValue
AuthRequired

Export Cap Table

GET /v1/organization/:organization/captable
FieldValue
AuthRequired
PermissioncanViewCapTable
Export the full cap table data.

Get Cap Table Dashboard

GET /v1/captable/:organization/dashboard
FieldValue
AuthRequired
PermissioncanViewOrganization

Get Cap Table Pools

GET /v1/captable/:organization/pool
FieldValue
AuthRequired
PermissioncanViewOrganization

Get Entity Profile Portfolio

GET /v1/entity/:entity/profile
FieldValue
AuthRequired
Get portfolio view for an entity showing all holdings across organizations.

Import CSV

GET /v1/organization/:organization/import
FieldValue
AuthRequired
Download a CSV template or previously uploaded import file.

Multi-Query

POST /v1/query
FieldValue
AuthRequired
Execute multiple data queries in a single request for efficient dashboard loading.