Vidbyte

API documentation

Browse docs

Get a Roadmap Module

Keys
OverviewQuickstartAuth & KeysConnectorsContext adapterImport from connectorsDeveloper guidelinesRate limitsSecurityResponse ShapeQuickhitsRoadmapsQuizzesExamsProjectsBlogContactoverview/create/get/list/get-module
GETLiveGETFocused route reference

GET /api/v1/roadmaps/get/{encrypted_id}/{module_number}

Get a Roadmap Module

Fetch a single roadmap module by roadmap id and module index. This is the focused retrieval path when you do not want to pull the full roadmap payload again.

Manage keys
Stable public contract

Public endpoint

/api/v1/roadmaps/get/{encrypted_id}/{module_number}

Maps to

/api/roadmap/get/{encrypted_id}/{module_number}

What to know first

Helpful when you want resource-level views without pulling the entire roadmap repeatedly.

Method

GET

Send this operation to /api/v1/roadmaps/get/{encrypted_id}/{module_number} on the versioned public host.

Authentication

API key

API key via Authorization: Bearer or x-api-key

Resource model

Parameterized

Helpful when you want resource-level views without pulling the entire roadmap repeatedly.

Highlights

What this operation does

Fetch a specific roadmap module by public roadmap id and module index.
Helpful when you want resource-level views without pulling the entire roadmap repeatedly.
Store the encrypted `id` returned by create and list routes exactly as returned if you need to fetch the resource again later.

Request details

Request parameters

Request parameters

These are the parameters that shape /api/v1/roadmaps/get/{encrypted_id}/{module_number}. Path parameters and request-body fields are shown together because the docs stay focused on the public route contract.

encrypted_idstringRequired

Encrypted public identifier returned by a create or list route.

module_numberintegerRequired

Zero-based module index within the roadmap.

Response shape

What the response contract guarantees

Public responses use the shared envelope: `success`, `id`, `message`, `data`, `token_stats`, `pricing`, and `error`.
The `id` field is always a public/encrypted identifier boundary, never a raw MongoDB `_id`.