Skip to main content
GET
Get a screen

Authorizations

Authorization
string
header
required

Bearer authentication using the project Secret Key (prefixed with sk_, or test_sk_ for sandbox). All v4 public endpoints require the Secret Key — see Authentication. Never expose the Secret Key in client-side code.

Path Parameters

screen_id
string
required

Screen identifier.

Maximum string length: 256
Pattern: ^[a-zA-Z0-9._-]+$

Query Parameters

render
boolean
default:true

Whether to include render-time fields (background, default_lang, configs, content, prod_key, sandbox_key, used) in the response.

  • true (default) — return the full V4Screen.
  • false — return the lean V4ScreenSummary.

Response

Screen details. The response is a V4Screen when render=true (default) or a V4ScreenSummary when render=false.

Full screen representation returned by GET /v4/screens/{screen_id}. Extends V4ScreenSummary with the render-time fields an SDK needs to initialise and display a paywall (DEV-777).

object
enum<string>
required
Available options:
screen
id
string
required
Example:

"scr_abc123"

url
string
required
Example:

"/v4/screens/scr_abc123"

name
string
required
Example:

"Onboarding Paywall"

status
string
required
Example:

"published"

is_web
boolean
default:false
required
created_at
string<date-time>
required
Example:

"2025-09-15T12:30:00Z"

updated_at
string<date-time>
required
Example:

"2025-11-03T10:26:40Z"

background
string | null
required

CSS background for the paywall root element.

default_lang
string | null
required

Default localisation key. When the SDK can't match the user's locale it falls back to this language.

Example:

"en"

configs
any
required

Base screen configuration. Opaque JSON blob consumed by the Qonversion SDK — shape is defined by the no-code editor and MAY evolve without a version bump.

prod_key
string | null
required

SDK integration key used in production builds. Load-bearing — the SDK cannot render the screen without it.

sandbox_key
string | null
required

SDK integration key for sandbox / test builds.

content
any
required

Localised screen content keyed by language code (e.g. { "en": {...}, "ru": {...} }). Each value is an opaque JSON blob consumed by the SDK renderer.

used
string[]
required

UIDs of triggers currently targeting this screen.

type
string | null
context_key
string | null