API
Documentation / API Reference

API Reference

Endpoint references for each module — payloads, responses, and error codes. Select a module to view its details.

Authentication

Registration, login, email verification, OAuth, password management, 2FA, passkeys, phone verification, onboarding, and profile (own and public).

→

Onboarding

Post-registration onboarding — role choice, questionnaire, the mentor profile it creates, and the mentor verification document step.

→

Onboarding — response

Reply to the frontend onboarding wizard spec: the four collections POST /onboarding was dropping, the interest catalogue, the eleven social platforms, and the phone number that was never accepted.

→

Availability

Availability rules, off-days, vacation mode, public and mentor slot discovery, and slot holds.

→

Booking

Session booking lifecycle — follow-up slots, request, detail, confirm, decline, cancel, payment.

→

Session Reviews

Mentee reviews of delivered sessions — the profile reviews tab, the booking write path, helpful votes, reports, and the mentor rating summary they recompute.

→

Session Reviews — response

Reply to the frontend profile-reviews spec: the write path that did not exist, the caption scope decision, and five deviations.

→

Stripe Setup

Dashboard configuration, webhook endpoint and events, API keys, subscription retry policy, local development, and the go-live checklist.

→

Payments

Stripe Checkout flow, course enrollment payments, webhook endpoint, and local development without Stripe credentials.

→

Earnings & Payouts

Mentor earnings, clearance, the platform fee, admin-defined payout methods, and the withdrawal lifecycle.

→

Earnings & Payouts — response

Reply to the frontend earnings and transaction-methods spec: what shipped, and the four assumptions that were wrong.

→

Mentor Analytics

The mentor dashboard in one call: session counts, delivered hours, students, per-currency earnings and the session breakdowns.

→

Mentor Analytics — response

Reply to the frontend analytics spec: what already shipped, and the four decisions blocking /mentor/analytics.

→

Payment System

How payments work internally — the ledger, webhook idempotency, gateway seam, settlers, and money conversion.

→

Verification Documents

Mentor KYC document upload, list, download, and delete.

→

Courses

Course authoring, discovery, audience pricing, enrollment, and learning progress.

→

Course pricing v2 — response

Reply to the v2 spec: what was already built, what shipped this round, the two bugs it uncovered, and the four decisions answered.

→

Communities

Mentor-owned communities — feed, XP & levelling, paid subscriptions, and gated courses.

→

Global Search

One search endpoint across posts, people, communities, and courses — free-text and hashtag modes, per-tab results, and visibility scoping.

→

Activity Log

A user's own chronological history across posts, comments, mentions, communities, courses, connections, sessions and payments.

→

Public Feed

Global social feed — connection graph, posts, reactions, comments, shares, polls, and reporting.

→

Following

One-way following alongside connections — follow/unfollow, follower and following lists, the is_following field across every user surface, and how connecting implies a follow.

→

Messaging & Chat

Direct 1:1 chat — request/accept handshake, messages, file attachments, and in-chat appointment booking.

→

User Blocking

Platform-wide blocking — how a block severs messaging, connections, feed, search and profile visibility in both directions.

→

Realtime & WebSockets

The Reverb socket layer — connecting with Echo, channel and event catalog for chat and notifications, typing indicators, reconnection, and the Coolify deployment.

→

Notifications

The platform notification engine — architecture, channels (in-app, email, real-time, push, SMS), setup for Windows dev and Linux servers, and the full catalog of notification types with their triggers.

→

Privacy

The privacy screen and its enforcement — who can see a profile, its connections, courses and contact detail, and who can message, comment, mention or find the user.

→

User Settings

Per-user preferences — the notification switches that gate delivery, appearance and locale, and how the notification resolver enforces them.

→

Chunked Upload

Resumable large-file uploads — init → chunk → complete lifecycle yielding an upload_id spent when creating a resource.

→

Media Storage

Public CDN files versus private files — how to recognise a private /media/{uuid} URL, exchange it for a short-lived signed link, and render it in Next.js.

→