> ## Documentation Index
> Fetch the complete documentation index at: https://docs.equa.cc/llms.txt
> Use this file to discover all available pages before exploring further.

# Cap Table Endpoints

> Shareholdings, securities, option plans, holdings, valuations, vesting schedules, and cap table exports

> **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
```

| Field      | Value             |
| ---------- | ----------------- |
| Auth       | Required          |
| Permission | `canEditCapTable` |

Create a new shareholding. Automatically updates the Chargify shareholder count.

***

### Transfer Shares

```
POST /v1/organization/:organization/shareholding/transfer
```

| Field      | Value             |
| ---------- | ----------------- |
| Auth       | Required          |
| Permission | `canEditCapTable` |

Transfer shares between members. Updates the Chargify shareholder count.

***

### List Shareholdings

```
GET /v1/organization/:organization/shareholding
```

| Field      | Value                         |
| ---------- | ----------------------------- |
| Auth       | Required                      |
| Permission | `canViewCapitalizationOrSelf` |

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
```

| Field      | Value            |
| ---------- | ---------------- |
| Auth       | Required         |
| Permission | `canViewHolding` |

***

### Edit Shareholding

```
PATCH /v1/shareholding/:holding
```

| Field      | Value            |
| ---------- | ---------------- |
| Auth       | Required         |
| Permission | `canEditHolding` |

***

### Replace Shareholding

```
PUT /v1/shareholding/:holding
```

| Field      | Value            |
| ---------- | ---------------- |
| Auth       | Required         |
| Permission | `canEditHolding` |

***

### Void Shareholding

```
DELETE /v1/shareholding/:holding
```

| Field      | Value            |
| ---------- | ---------------- |
| Auth       | Required         |
| Permission | `canEditHolding` |

Void (soft delete) a shareholding. Updates the Chargify shareholder count.

***

### Get Shareholding Config

```
GET /v1/organization/:organization/shareholding/config
```

| Field      | Value             |
| ---------- | ----------------- |
| Auth       | Required          |
| Permission | `canViewCapTable` |

Get shareholding configuration (operating agreement settings).

***

### Get Shareholding Certificate

```
GET /v1/shareholding/:holding/certificate
```

| Field      | Value            |
| ---------- | ---------------- |
| Auth       | Required         |
| Permission | `canViewHolding` |

Generate and download a share certificate PDF.

***

### Get Certificate Copy

```
GET /v1/shareholding/:holding/certificate/copy
```

| Field      | Value            |
| ---------- | ---------------- |
| Auth       | Required         |
| Permission | `canViewHolding` |

Generate a copy of the share certificate.

***

## Securities

### Create Security

```
POST /v1/organization/:organization/security
```

| Field      | Value             |
| ---------- | ----------------- |
| Auth       | Required          |
| Permission | `canEditCapTable` |

***

### Update Security

```
PUT /v1/organization/:organization/security/:security
```

| Field      | Value             |
| ---------- | ----------------- |
| Auth       | Required          |
| Permission | `canEditCapTable` |

***

### List Securities

```
GET /v1/organization/:organization/security
```

| Field      | Value                 |
| ---------- | --------------------- |
| Auth       | Required              |
| Permission | `canViewOrganization` |

***

### Get Security

```
GET /v1/organization/:organization/security/:security
```

| Field      | Value                 |
| ---------- | --------------------- |
| Auth       | Required              |
| Permission | `canViewOrganization` |

***

### Delete Security

```
DELETE /v1/organization/:organization/security/:security
```

| Field      | Value             |
| ---------- | ----------------- |
| Auth       | Required          |
| Permission | `canEditCapTable` |

***

### Add Shares to Security

```
POST /v1/organization/:organization/security/:security/shares
```

| Field      | Value             |
| ---------- | ----------------- |
| Auth       | Required          |
| Permission | `canEditCapTable` |

Add authorized shares to a security type.

***

## Legends

### Create Legend

```
POST /v1/organization/:organization/legend
```

| Field      | Value             |
| ---------- | ----------------- |
| Auth       | Required          |
| Permission | `canEditCapTable` |

***

### List Legends

```
GET /v1/organization/:organization/legend
```

| Field      | Value             |
| ---------- | ----------------- |
| Auth       | Required          |
| Permission | `canViewCapTable` |

***

### Get Legend

```
GET /v1/organization/:organization/legend/:legend
```

| Field      | Value             |
| ---------- | ----------------- |
| Auth       | Required          |
| Permission | `canViewCapTable` |

***

### Update Legend

```
PATCH /v1/organization/:organization/legend/:legend
```

| Field      | Value             |
| ---------- | ----------------- |
| Auth       | Required          |
| Permission | `canEditCapTable` |

***

### Delete Legend

```
DELETE /v1/organization/:organization/legend/:legend
```

| Field      | Value             |
| ---------- | ----------------- |
| Auth       | Required          |
| Permission | `canEditCapTable` |

***

### Get Legend Certificate

```
GET /v1/organization/:organization/legend/:legend/certificate
```

| Field      | Value             |
| ---------- | ----------------- |
| Auth       | Required          |
| Permission | `canViewCapTable` |

***

## Option Plans

### Create Plan

```
POST /v1/organization/:organization/plan
```

| Field      | Value             |
| ---------- | ----------------- |
| Auth       | Required          |
| Permission | `canEditCapTable` |

***

### List Plans

```
GET /v1/organization/:organization/plan
```

| Field      | Value                 |
| ---------- | --------------------- |
| Auth       | Required              |
| Permission | `canViewOrganization` |

***

### Get Plan

```
GET /v1/plan/:plan
```

| Field | Value    |
| ----- | -------- |
| Auth  | Required |

***

### Update Plan

```
PUT /v1/plan/:plan
```

| Field      | Value         |
| ---------- | ------------- |
| Auth       | Required      |
| Permission | `canEditPlan` |

***

### Delete Plan

```
DELETE /v1/plan/:plan
```

| Field      | Value         |
| ---------- | ------------- |
| Auth       | Required      |
| Permission | `canEditPlan` |

Deletes a plan and updates the Chargify member count.

***

### Get Plan Dashboard

```
GET /v1/plan/:plan/dashboard
```

| Field | Value    |
| ----- | -------- |
| Auth  | Required |

Get dashboard summary data for an option plan.

***

## Pools and Options

### List Pool Options

```
GET /v1/plan/:plan/pool/:pool/option
```

| Field      | Value         |
| ---------- | ------------- |
| Auth       | Required      |
| Permission | `canViewPool` |

***

### Get Option (Nested)

```
GET /v1/plan/:plan/pool/:pool/option/:option
```

<Warning>
  **Deprecated.** Use [`GET /v1/option/:option`](#get-option) instead.
  This endpoint will be removed in a future API version.
</Warning>

| Field      | Value              |
| ---------- | ------------------ |
| Auth       | Required           |
| Permission | `canViewOptionOld` |

***

### Get Option

```
GET /v1/option/:option
```

| Field      | Value           |
| ---------- | --------------- |
| Auth       | Required        |
| Permission | `canViewOption` |

***

### List Organization Options

```
GET /v1/organization/:organization/option
```

| Field      | Value                 |
| ---------- | --------------------- |
| Auth       | Required              |
| Permission | `canViewOrganization` |

***

### Get Member Options

```
GET /v1/member/:member/options
```

| Field      | Value           |
| ---------- | --------------- |
| Auth       | Required        |
| Permission | `canViewMember` |

***

### Exercise Option

```
POST /v1/plan/:plan/pool/:pool/option/:option/exercise
```

| Field      | Value                   |
| ---------- | ----------------------- |
| Auth       | Required                |
| Permission | `canEditExerciseOption` |

***

### Request Option Exercise

```
POST /v1/plan/:plan/pool/:pool/option/:option/exercise/request
```

| Field      | Value                   |
| ---------- | ----------------------- |
| Auth       | Required                |
| Permission | `canEditExerciseOption` |

***

## Holdings

### Create Holding

```
POST /v1/holding
```

| Field      | Value     |
| ---------- | --------- |
| Auth       | Required  |
| Permission | `canEdit` |

Create a new holding (option grant, convertible note, SAFE, etc.). Updates the Chargify member count.

***

### Update Holding

```
PUT /v1/holding/:holding
```

| Field      | Value            |
| ---------- | ---------------- |
| Auth       | Required         |
| Permission | `canEditHolding` |

***

### Patch Holding

```
PATCH /v1/holding/:holding
```

| Field      | Value            |
| ---------- | ---------------- |
| Auth       | Required         |
| Permission | `canEditHolding` |

***

### List Holdings

```
GET /v1/holding
```

| Field | Value    |
| ----- | -------- |
| Auth  | Required |

List holdings for the authenticated user's entities.

***

### Get Holding

```
GET /v1/holding/:holding
```

| Field      | Value            |
| ---------- | ---------------- |
| Auth       | Required         |
| Permission | `canViewHolding` |

***

### Delete Holding

```
DELETE /v1/holding/:holding
```

| Field      | Value            |
| ---------- | ---------------- |
| Auth       | Required         |
| Permission | `canEditHolding` |

***

### Repay Holding

```
POST /v1/holding/:holding/repay
```

| Field      | Value            |
| ---------- | ---------------- |
| Auth       | Required         |
| Permission | `canEditHolding` |

Record a repayment against a debt holding (convertible note).

***

### Convert Holding

```
POST /v1/holding/:holding/convert
```

| Field      | Value            |
| ---------- | ---------------- |
| Auth       | Required         |
| Permission | `canEditHolding` |

Convert a holding (e.g., SAFE or convertible note) into equity.

***

## Capital Changes

### Create Capital Change

```
POST /v1/entity/:entity/capitalChange
```

| Field      | Value     |
| ---------- | --------- |
| Auth       | Required  |
| Permission | `canEdit` |

***

### Edit Capital Contributions

```
PATCH /v1/entity/:entity/capitalChange
```

| Field      | Value     |
| ---------- | --------- |
| Auth       | Required  |
| Permission | `canEdit` |

***

## Valuations

### Create/Update Valuation

```
PUT /v1/valuation
```

| Field      | Value     |
| ---------- | --------- |
| Auth       | Required  |
| Permission | `canEdit` |

***

### List Valuations

```
GET /v1/organization/:organization/valuation
```

| Field      | Value             |
| ---------- | ----------------- |
| Auth       | Required          |
| Permission | `canViewCapTable` |

***

### Get Valuation

```
GET /v1/valuation/:valuation
```

| Field      | Value              |
| ---------- | ------------------ |
| Auth       | Required           |
| Permission | `canViewValuation` |

***

## Vesting Schedules

### Create Vesting Schedule

```
POST /v1/vestingSchedule
```

| Field | Value    |
| ----- | -------- |
| Auth  | Required |

***

### Update Vesting Schedule

```
PUT /v1/vestingSchedule/:vestingScheduleOld
```

| Field | Value    |
| ----- | -------- |
| Auth  | Required |

***

### Delete Vesting Schedule

```
DELETE /v1/plan/:plan/vestingSchedule/:vestingSchedule
```

| Field | Value    |
| ----- | -------- |
| Auth  | Required |

***

### Get Vesting Schedule

```
GET /v1/vestingSchedule/:vestingSchedule
```

| Field | Value    |
| ----- | -------- |
| Auth  | Required |

***

### List Vesting Schedules

```
GET /v1/vestingSchedule
```

| Field | Value    |
| ----- | -------- |
| Auth  | Required |

***

### Project Vesting Schedule

```
POST /v1/schedule/project
```

| Field | Value    |
| ----- | -------- |
| Auth  | Required |

Project/preview a vesting schedule calculation without saving.

***

## Utility

### Get Blocks

```
GET /v1/organization/:organization/block
```

| Field      | Value                         |
| ---------- | ----------------------------- |
| Auth       | Required                      |
| Permission | `canViewCapitalizationOrSelf` |

***

### Get Incentive Documents

```
GET /v1/incentive/documents
```

| Field | Value    |
| ----- | -------- |
| Auth  | Required |

***

### Export Cap Table

```
GET /v1/organization/:organization/captable
```

| Field      | Value             |
| ---------- | ----------------- |
| Auth       | Required          |
| Permission | `canViewCapTable` |

Export the full cap table data.

***

### Get Cap Table Dashboard

```
GET /v1/captable/:organization/dashboard
```

| Field      | Value                 |
| ---------- | --------------------- |
| Auth       | Required              |
| Permission | `canViewOrganization` |

***

### Get Cap Table Pools

```
GET /v1/captable/:organization/pool
```

| Field      | Value                 |
| ---------- | --------------------- |
| Auth       | Required              |
| Permission | `canViewOrganization` |

***

### Get Entity Profile Portfolio

```
GET /v1/entity/:entity/profile
```

| Field | Value    |
| ----- | -------- |
| Auth  | Required |

Get portfolio view for an entity showing all holdings across organizations.

***

### Import CSV

```
GET /v1/organization/:organization/import
```

| Field | Value    |
| ----- | -------- |
| Auth  | Required |

Download a CSV template or previously uploaded import file.

***

### Multi-Query

```
POST /v1/query
```

| Field | Value    |
| ----- | -------- |
| Auth  | Required |

Execute multiple data queries in a single request for efficient dashboard loading.
