Compass DocsBy Mesa
Open App

📖 Endpoint Reference

Every endpoint shares the same conventions. Learn them once and they hold across the whole API.

Conventions

  • Base URL. https://compass.mesa.so
  • Version. Data endpoints live under /api/v1.
  • Auth. Every request carries Authorization: Bearer ck_live_…. See Authentication & API Keys.
  • Format. Requests and responses are JSON.
  • Errors. Failures return { "error": "..." } with a standard status code. See Errors & Status Codes.

Lists and pagination

Endpoints that return many records are paged. Pass a page query parameter and read the envelope:

{
  "data": [],
  "total": 0,
  "page": 1,
  "totalPages": 0
}

data is the page of records, total is the full count, and totalPages tells you how many pages to walk. Single-record endpoints return the record directly.

The endpoints

Endpoint Purpose Status Credits
GET /api/v1/me Identity, plan, and credit balance Live 0
GET /api/v1/people Search and filter people Live 5
GET /api/v1/people/{id} Full profile + coworkers; reveal channels Live 5 / 10
GET /api/v1/projects Search and filter projects Live 5
GET /api/v1/projects/{id} One project with its team Live 5
GET /api/v1/investors Search and filter funds Live 5
GET /api/v1/investors/{slug} One fund with team + portfolio Live 5
GET /api/v1/search Cross search projects + people Live 5
GET /api/v1/network The connections graph Planned —

The live data endpoints are documented in Data Endpoints. The network graph is still planned; watch the Roadmap & Availability page.