Vidbyte

API documentation

Browse docs

Get a Roadmap

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

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

Get a Roadmap

Fetch one roadmap by encrypted public id. This route is the standard way to rehydrate a stored roadmap inside your product after creation.

Manage keys
Stable public contract

Public endpoint

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

Maps to

/api/roadmap/get/{encrypted_id}

What to know first

Returns the full roadmap resource boundary rather than a raw database document.

Method

GET

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

Authentication

API key

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

Resource model

Parameterized

Returns the full roadmap resource boundary rather than a raw database document.

Highlights

What this operation does

Fetch one roadmap by encrypted public id.
Returns the full roadmap resource boundary rather than a raw database document.
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}. 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.

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`.