Skip to main content

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.

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 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 and use Content-Type: application/problem+json.

​
Resources

Resource groupDescription
StakeholdersPeople and entities holding equity
SecuritiesShares, options, warrants, and convertibles
Share classesStock classes on the cap table
Valuations409A and financing valuations
VestingVesting terms and milestones
Equity plansOption plans and pools
Corporate actionsSplits, conversions, and board-approved events
TransactionsLedger-level mutations — issue, transfer, exercise, cancel
ApprovalsApproval workflow for transactions
Cap tableAggregated cap table data and OCF import/export
Organization & API keysOrg settings and API key management

​
Quick start

Fetch your organization’s stakeholders with a single curl call: 
curl https://launchboard.xyz/api/v1/stakeholders \
  -H "Authorization: Bearer pg_live_your_key_here"

{
  "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 for details.