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

# Launchboard REST API reference

> The Launchboard v1 API gives you programmatic access to every cap table operation — reads and mutations — via a JSON REST interface.

The Launchboard API is a headless REST API (OpenAPI 3.1) that exposes every operation available in the Launchboard product. Every read and every mutation you can perform in the UI — creating stakeholders, issuing securities, recording transactions, exporting an OCF snapshot — is also available here. If you're building an integration, automating equity workflows, or syncing Launchboard data into a downstream system, this API is your entry point.

## Base URL

All v1 endpoints are served from:

```
https://launchboard.xyz/api/v1
```

## OpenAPI spec

The machine-readable OpenAPI 3.1 document is available at:

```
GET https://launchboard.xyz/api/v1/openapi.json
```

Import it into any OpenAPI-compatible tool — Postman, Insomnia, or an SDK generator — to get a typed client with no additional setup.

## Authentication

All requests must include an API key as a bearer token in the `Authorization` header:

```
Authorization: Bearer pg_live_your_key_here
```

Create your API key in **Settings → API Keys**. See the [authentication guide](/api-reference/authentication) for full details, including error codes and security considerations.

## Request and response format

The API accepts and returns JSON. Set `Content-Type: application/json` on all requests with a body.

Error responses follow [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457.html) and use `Content-Type: application/problem+json`.

## Resources

| Resource group              | Description                                                |
| --------------------------- | ---------------------------------------------------------- |
| **Stakeholders**            | People and entities holding equity                         |
| **Securities**              | Shares, options, warrants, and convertibles                |
| **Share classes**           | Stock classes on the cap table                             |
| **Valuations**              | 409A and financing valuations                              |
| **Vesting**                 | Vesting terms and milestones                               |
| **Equity plans**            | Option plans and pools                                     |
| **Corporate actions**       | Splits, conversions, and board-approved events             |
| **Transactions**            | Ledger-level mutations — issue, transfer, exercise, cancel |
| **Approvals**               | Approval workflow for transactions                         |
| **Cap table**               | Aggregated cap table data and OCF import/export            |
| **Organization & API keys** | Org settings and API key management                        |

## Quick start

Fetch your organization's stakeholders with a single `curl` call:

```bash theme={null}
curl https://launchboard.xyz/api/v1/stakeholders \
  -H "Authorization: Bearer pg_live_your_key_here"
```

```json theme={null}
{
  "data": [
    {
      "id": "sh_01hx4k2m9b3c7nt8pqrz6v5wde",
      "name": "Alice Chen",
      "email": "alice@example.com",
      "type": "INDIVIDUAL",
      "createdAt": "2024-03-15T10:22:00.000Z"
    }
  ],
  "nextCursor": "eyJpZCI6InNoXzAxaHg0azJtOWIzYzdudDhwcXJ6NnY1d2RlIiwiY3JlYXRlZEF0IjoiMjAyNC0wMy0xNVQxMDoyMjowMC4wMDBaIn0"
}
```

List endpoints return paginated results. Pass the `nextCursor` value as a `cursor` query parameter to fetch the next page. See the [pagination guide](/api-reference/pagination) for details.