Roadmap Tracker
Query public features, development status, and completion statistics.
Description
Transparency is a core tenet of VeriWorkly. The Roadmap API exposes our internal development pipeline directly to the public. This allows the community (and our frontend client) to query upcoming features, track active progress, and view historical completion data.
Unlike the GitHub module (whose records originate from an external repository), roadmap entries are authored directly in our PostgreSQL database, and responses are Redis-cached for fast reads.
Query Parameters & Pagination
Because the roadmap will grow indefinitely over the lifecycle of the project, the list endpoint is heavily optimized for large datasets.
- Offset Pagination: Lists are paginated with a default page size of 20 and a hard maximum of 50 — a
limitabove 50 is rejected with400, not clamped. You can page with eitherlimit/offsetorpage/pageSize; the response echoes both, plustotalPages,hasMore, and apaginationblock. - Granular Filtering: Filter the pipeline by lifecycle
status(todo,in-progress,done), and drop a specific entry withexcludeIdwhen building "related features" lists. - Chronological Sorting: Sort via
newest(default),oldest, orrecently-completed.
Authentication
| Method | Access Level | Requirement |
|---|---|---|
GET | No session | An API key with the roadmap:read scope, or a whitelisted first-party origin. |
No user session is needed to read the roadmap, but these endpoints are not open to anonymous
callers — a request carrying neither an API key nor a whitelisted first-party Origin/Referer
is rejected with 401.
Available Endpoints
GET /roadmap— List Roadmap FeaturesGET /roadmap/stats— Fetch Roadmap StatsGET /roadmap/{id}— Get Feature Details
Apply For Campus Ambassador ProgramPOST
Submits (or resubmits, once previously rejected) a campus ambassador application. Rejects a duplicate application from a user who already has one pending review, and rejects existing ambassadors from re-applying. `graduationYear` is validated as a real 4-digit year on both the client and the server. Session-authenticated only.
Get Roadmap FeaturesGET
Fetch roadmap features with optional filtering, sorting, and pagination. This endpoint has no user session of its own: call it with an API key holding the `roadmap:read` scope, or from a whitelisted first-party origin. A request with neither is rejected with `401`.