API/API v1 Proxy

API v1 Proxy

How Lynkero exposes Convex HTTP actions through the app API namespace.

Lynkero keeps application data in Convex. Public API requests under /api/v1/* are proxied by TanStack Start to the matching Convex HTTP action, so integrations can use the app domain while Convex remains the source of truth.

Available Endpoints

GET /api/v1/me
GET /api/v1/members
GET /api/v1/members/:memberId

Authentication

Create an API key from the organization workspace:

/orgs/{orgSlug}/settings/api-keys

Send the key with either header:

x-api-key: YOUR_API_KEY
Authorization: Bearer YOUR_API_KEY

Runtime Notes

  • The app route at src/routes/api/v1/$.ts forwards the request to VITE_CONVEX_SITE_URL.
  • Convex handles the actual API implementation in convex/http.ts.
  • API keys are organization scoped.
  • Error responses use a compact { "message": string } shape.

Production Checklist

  • Set VITE_CONVEX_SITE_URL to the Convex site URL for the target deployment.
  • Verify API keys in /settings/api-keys before sharing integration docs.
  • Keep new API routes in Convex HTTP actions unless they need TanStack-only behavior.