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.

Stakeholders are the equity holders on your cap table — founders, employees, investors, advisors, and institutional entities. Every security must be linked to a stakeholder, so creating stakeholders is typically the first step when building out your cap table programmatically. The API supports cursor-based pagination and free-text search across displayName and email.

Endpoints

MethodPathDescription
GET/api/v1/stakeholdersList stakeholders (cursor-paginated)
POST/api/v1/stakeholdersCreate a stakeholder
GET/api/v1/stakeholders/{id}Get a single stakeholder
PATCH/api/v1/stakeholders/{id}Partially update a stakeholder
DELETE/api/v1/stakeholders/{id}Delete a stakeholder

List stakeholders

Returns a cursor-paginated list of all stakeholders belonging to your organization. Filter by type, status, or search by name and email with the q parameter.
curl https://launchboard.xyz/api/v1/stakeholders \
  -H "Authorization: Bearer pg_live_your_key"

Query parameters

query.q
string
Free-text search against displayName and email. Case-insensitive partial match.
query.type
string
Filter by stakeholder type. One of INDIVIDUAL or INSTITUTION.
query.status
string
Filter by stakeholder status. One of CURRENT or FORMER.
query.limit
number
default:"25"
Maximum results per page. Capped at 100.
query.cursor
string
Opaque cursor from a previous response’s nextCursor field. Omit to fetch from the beginning.

Response

items
object[]
Array of stakeholder objects.
nextCursor
string | null
Pass this value as cursor on the next request to retrieve the following page. null when you are on the last page.

Create a stakeholder

Creates a new stakeholder. Supports the Idempotency-Key request header — if you retry with the same key, the API returns the previously created stakeholder instead of creating a duplicate.
curl -X POST https://launchboard.xyz/api/v1/stakeholders \
  -H "Authorization: Bearer pg_live_your_key" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: create-stakeholder-alice-2024" \
  -d '{
    "displayName": "Alice Chen",
    "name": {
      "legalName": "Alice Chen",
      "firstName": "Alice",
      "lastName": "Chen"
    },
    "type": "INDIVIDUAL",
    "status": "CURRENT",
    "email": "alice@example.com",
    "relationships": ["FOUNDER", "EMPLOYEE"],
    "issuerAssignedId": "EMP-001"
  }'

Request body

displayName
string
required
Short display name. Maximum 100 characters.
name
object
required
Legal name object.
type
string
required
INDIVIDUAL or INSTITUTION.
status
string
default:"CURRENT"
CURRENT or FORMER.
email
string
Contact email address.
relationships
string[]
default:"[]"
Array of relationship labels. Valid values: ADVISOR, BOARD_MEMBER, CONSULTANT, EMPLOYEE, EX_ADVISOR, EX_CONSULTANT, EX_EMPLOYEE, EXECUTIVE, FOUNDER, INVESTOR, OTHER.
issuerAssignedId
string
Your internal identifier for this stakeholder. Maximum 100 characters.
comments
string
Free-text notes. Maximum 2000 characters.
sourceDocumentId
string
UUID of a source document to associate with this stakeholder.

Response

Returns 201 Created with the full stakeholder object and a Location header pointing to the new resource.

Get a stakeholder

curl https://launchboard.xyz/api/v1/stakeholders/abc123 \
  -H "Authorization: Bearer pg_live_your_key"
Returns the stakeholder object. Field schema is identical to the list response items. Returns 404 if the stakeholder does not exist in your organization.

Update a stakeholder

Partial update — only include the fields you want to change. All body fields are optional.
curl -X PATCH https://launchboard.xyz/api/v1/stakeholders/abc123 \
  -H "Authorization: Bearer pg_live_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "FORMER",
    "relationships": ["EX_EMPLOYEE"]
  }'

Request body

All fields from the create request body are accepted; all are optional for PATCH. Returns 200 OK with the updated stakeholder object.

Delete a stakeholder

curl -X DELETE https://launchboard.xyz/api/v1/stakeholders/abc123 \
  -H "Authorization: Bearer pg_live_your_key"
Returns 204 No Content on success.

Common errors

StatusWhen it occurs
400Malformed JSON in the request body.
401Missing or invalid Authorization header.
403The API key role does not have EDITOR permission. Required for POST, PATCH, and DELETE.
404No stakeholder with the given id exists in your organization.
422Request body failed schema validation. The response includes a field-level errors array.
Use the Idempotency-Key header on all POST requests to safely handle network retries without creating duplicate stakeholders.