Vidbyte

API documentation

Browse docs

Get an Exam

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

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

Get an Exam

Fetch one exam by encrypted public id. Use this to rehydrate a stored exam in your application after the create flow has completed.

Manage keys
Stable public contract

Public endpoint

/api/v1/exams/get/{encrypted_id}

Maps to

/api/sandbox/exams/get/{encrypted_id}

What to know first

Use the `id` returned by create/list, never an internal database id.

Method

GET

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

Authentication

API key

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

Resource model

Parameterized

Use the `id` returned by create/list, never an internal database id.

Highlights

What this operation does

Fetch one exam by encrypted public id.
Use the `id` returned by create/list, never an internal database id.
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/exams/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`.