Vidbyte

API documentation

Browse docs

Get a Quiz

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

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

Get a Quiz

Fetch one previously generated quiz by encrypted public id. Use this after your application has persisted the id returned from create, batch create, or list.

Manage keys
Stable public contract

Public endpoint

/api/v1/quizzes/get/{encrypted_id}

Maps to

/api/sandbox/quizzes/get/{encrypted_id}

What to know first

The returned payload includes sanitized `quiz_data` only for the owned resource.

Method

GET

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

Authentication

API key

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

Resource model

Parameterized

The returned payload includes sanitized `quiz_data` only for the owned resource.

Highlights

What this operation does

Fetch one quiz by encrypted public id.
The returned payload includes sanitized `quiz_data` only for the owned resource.
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/quizzes/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`.