π Endpoint Reference
Every endpoint shares the same conventions. Learn them once and they hold across the whole API.
Conventions
- Base URL.
https://api.compass.mesa.so - Version. Data endpoints live under
/v1. Every response carries aCompass-API-Versionheader naming the build of the plane that served it. It is additive semver: new fields raise the minor, so>= 1.2.0tells youticker,chains,discordUrl,linkedinUrlandslugare populated rather than absent. - This table is not the reference of record.
GET /v1/mereturns the same list, generated from the price table that bills you, so it can never quote a price it does not charge. It is free. Read it from there and you are never reading a stale page. - 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 /v1/me |
Identity, plan, and credit balance | Live | 0 |
GET /v1/people |
Search and filter people | Live | 5 |
GET /v1/people/{id} |
Full profile + coworkers; reveal channels | Live | 5 / 10 |
GET /v1/projects |
Search and filter projects | Live | 5 |
GET /v1/projects/{id} |
One project with its team | Live | 5 |
GET /v1/investors |
Search and filter funds | Live | 5 |
GET /v1/investors/{slug} |
One fund with team + portfolio | Live | 5 |
GET /v1/services |
Search and filter service providers | Live | 5 |
GET /v1/services/{slug} |
One provider with its team | Live | 5 |
GET /v1/search |
Cross search projects + people | Live | 5 |
GET /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.