API Reference

Every Super People API module, one page each: its endpoints and the models they send and return.

One page per module. Every route is relative to the base URL in Getting Started and starts with /api/v1.

Generated from the OpenAPI spec by npm run docs:api -w api. The live interactive version is at GET /api/v1/docs.

Module	Endpoints	Covers
Service	1	The liveness check — the only route that needs no session.
Profiles & Directory	12	Your own profile and avatar, the people directory with its filters, the org chart, skills and the contributor leaderboard.
Feed & Posts	33	The feed, writing and editing posts with media, polls and recognitions, reactions, bookmarks, shares, follows and comments.
Office Updates	7	Approving posts for the public Office Updates page on superlabs.co, and the two public routes that page reads.
Announcements	7	Super admin announcements: the scrolling bar and popup in the app, the public route superlabs.co reads for its own bar, and managing them.
Events	4	Company events: list what is coming up, add, reschedule and remove.
Birthdays	5	Today's birthdays, sending wishes, and hearting or replying to the wishes you received.
Notifications	7	The notification list and unread badge, push token registration, and push preferences.
Presence	3	Heartbeats that tell the server which clients are open, so people show as online.
Teams	4	Every team, and creating, renaming, recolouring and deleting them.
Meetings	7	Scheduling meetings with colleagues and external guests, changing or cancelling them, and attaching the recording afterwards.
Attendance	5	Checking in and out for the day, today's record, and attendance history.
Leave	6	Applying for leave, and approving or disapproving the requests routed to you.
Grievances	16	The anonymous grievance channel: raising, reading and answering grievances, and the super-admin queue.
Admin — Members	6	Super-admin member management: create employees, activate or deactivate them, reset passwords, change roles, feature contributors.
Files	1	Downloading uploaded files such as post documents.