GET /api/v1/roadmaps/list

List Roadmaps

List the roadmaps owned by the authenticated principal. Use this route when your application needs to discover or reconcile previously created roadmap resources.

GET
https://api.vidbyte.pro/api/v1/roadmaps/list

Example request

bash
curl "https://api.vidbyte.pro/api/v1/roadmaps/list?limit=20&page=1" \ -H "x-api-key: vb_live_your_api_key"

Example response

JSON
{ "success": true, "message": "Roadmaps retrieved successfully.", "data": [ { "encrypted_id": "3f2504e0-4f89-41d3-9a0c-0305e82c3301", "title": "", "experience": ["intermediate"], "timeline": "8 weeks", "resource_preference": ["reading and docs"], "modules": [{ "title": "API fundamentals" }] } ], "object": "roadmap", "pagination": { "limit": 20, "page": 1, "has_more": false } }

Parameter information

These are the public parameters for /api/v1/roadmaps/list. Path, query, and request-body parameters are shown together so the page stays focused on the live request contract you actually send.

limitintegerOptional

Query parameter: how many items to return per page, from 1 to 100, for example ?limit=20.

Default

100