Super People Docs

Super People

Documentation for the Super People API, its web and mobile clients, and running it in production.

The mobile app and the web app talk to the same API — there is no separate mobile backend. Only the session differs: the web app sends a cookie, the mobile app sends a bearer token.

  • Interactive API reference (always current): GET /api/v1/docs
  • Machine-readable spec: GET /api/v1/openapi.json
  • Base URLs: http://localhost:3101 local, https://api-peoples.superlabs.co production

Getting Started

How the API works across every module. Read Authentication and Conventions first.

PageCovers
Getting StartedEnvironments, the spec, generating a typed client
AuthenticationSign in, the bearer token, session lifetime, 401, sign out
ConventionsPaging, errors, dates and ids, request bodies
Roles and VisibilityMember vs super admin
MediaUploading and resolving images, videos, documents
The Content ModelMentions, hashtags, posts, reactions, polls, recognitions, comments
Notifications and Live UpdatesPush, the unread badge, the SSE stream
Enums and LimitsFixed value sets and size caps
Client Structure and ChecklistSuggested layout and pre-ship checks
Grievance Channel walkthroughThe grievance flow end to end

API Reference

One page per module — endpoints plus the models they use. See the full module list.

Operations

PageFor
Backend ConfigurationEnvironment variables clients depend on
Browser push smoke testThe real-browser check after a push-related release

On this page