Sign in

v1

latestOpenAPI 3.0.32026-07-26120117318.1 KB
Screens

Get a screen

Returns a single screen by ID.

By default the response is the full V4Screen, including the render-time fields (background, default_lang, configs, content, prod_key, sandbox_key, used) an SDK needs to display a paywall.

Pass render=false to receive the lean V4ScreenSummary instead — the same shape returned on GET /v4/screens. Useful when you only need metadata and want to avoid fetching the render payload, which can be several kilobytes per screen.

get/screens/{screen_id}

Path parameters

screen_idstring required

Screen identifier.

Query parameters

renderboolean

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.

OR

Example response

{
  "id": "scr_abc123",
  "url": "/v4/screens/scr_abc123",
  "name": "Onboarding Paywall",
  "status": "published",
  "created_at": "2025-09-15T12:30:00Z",
  "updated_at": "2025-11-03T10:26:40Z",
  "default_lang": "en"
}