---
title: "Changes to Retrieve Paywall Preview Images"
method: GET
path: "/v2/paywalls/{id}/preview-images"
---

# Changes to Retrieve Paywall Preview Images

`GET /v2/paywalls/{id}/preview-images`

> Every recorded change to this endpoint, newest first.

## Timeline

Changed in 3 of 14 revisions.

- **2026-09-16** `a01b83699803` — 8 info
- **2026-09-09** `217c96dc9a29` — 21 breaking, 151 info
- **2026-09-04** `7dbbee8e0305` — 1 info

## Changes

- **2026-09-16** `a01b83699803` — 8 info
  - added the new optional `query` request parameter `country`
  - added the new optional `query` request parameter `intro`
  - added the new optional `query` request parameter `locale`
  - added the optional property `branch_dimensions` to the response with the `200` status
  - added the optional property `pages/items/host_page_node_id` to the response with the `200` status
  - added the optional property `pages/items/kind` to the response with the `200` status
  - added the optional property `pages/items/overlay_node_id` to the response with the `200` status
  - added the optional property `render_context` to the response with the `200` status
- **2026-09-09** `217c96dc9a29` — 21 breaking, 151 info
  - the `code` response's property type changed from `string` to no type for status `403`
  - the `code` response's property type changed from `string` to no type for status `404`
  - the `code` response's property type changed from `string` to no type for status `429`
  - the `code` response's property type changed from `string` to no type for status `500`
  - the `code` response's property type changed from `string` to no type for status `503`
  - the `doc_url` response's property type changed from `string` to no type for status `403`
  - the `doc_url` response's property type changed from `string` to no type for status `404`
  - the `message` response's property type changed from `string` to no type for status `404`
  - the `message` response's property type changed from `string` to no type for status `429`
  - the `message` response's property type changed from `string` to no type for status `500`
  - the `message` response's property type changed from `string` to no type for status `503`
  - the `param` response's property type changed from `string` to no type for status `404`
  - the `required_scope` response's property type changed from `string` to no type for status `403`
  - the `resource_id` response's property type changed from `string` to no type for status `404`
  - the `resource_type` response's property type changed from `string` to no type for status `404`
  - the `retry_after` response's property type changed from `number` to no type for status `429`
  - the `type` response's property type changed from `string` to no type for status `403`
  - the `type` response's property type changed from `string` to no type for status `404`
  - the `type` response's property type changed from `string` to no type for status `429`
  - the `type` response's property type changed from `string` to no type for status `500`
  - the `type` response's property type changed from `string` to no type for status `503`
  - added `subschema #1, subschema #2, subschema #3, subschema #4, subschema #5` to the response body `anyOf` list for the response status `401`
  - added `subschema #2` to the response body `anyOf` list for the response status `400`
  - removed `subschema #1: Missing API Key, subschema #2: Invalid API Key Format, subschema #3: Invalid API Key, subschema #4: Authentication Failed, subschema #5: Invalid Session` from the response body `anyOf` list for the response status `401`
  - removed `subschema #2: Bad Request` from the response body `anyOf` list for the response status `400`
  - added `subschema #1` to the `cause` response property `anyOf` list for the response status `500`
  - added `subschema #1` to the `code` response property `anyOf` list for the response status `403`
  - added `subschema #1` to the `code` response property `anyOf` list for the response status `404`
  - added `subschema #1` to the `code` response property `anyOf` list for the response status `429`
  - added `subschema #1` to the `code` response property `anyOf` list for the response status `500`
  - added `subschema #1` to the `code` response property `anyOf` list for the response status `503`
  - added `subschema #1` to the `doc_url` response property `anyOf` list for the response status `403`
  - added `subschema #1` to the `doc_url` response property `anyOf` list for the response status `404`
  - added `subschema #1` to the `message` response property `anyOf` list for the response status `404`
  - added `subschema #1` to the `message` response property `anyOf` list for the response status `429`
  - added `subschema #1` to the `message` response property `anyOf` list for the response status `500`
  - added `subschema #1` to the `message` response property `anyOf` list for the response status `503`
  - added `subschema #1` to the `param` response property `anyOf` list for the response status `404`
  - added `subschema #1` to the `required_scope` response property `anyOf` list for the response status `403`
  - added `subschema #1` to the `resource_id` response property `anyOf` list for the response status `404`
  - …132 more
  - …this revision’s changelog is incomplete
- **2026-09-04** `7dbbee8e0305` — 1 info
  - endpoint added

---

[Operation](https://skmtc.dev/superwall/apis/superwall-api-v2/docs/v2/paywalls/:id/preview-images/get.md) · [API](https://skmtc.dev/superwall/apis/superwall-api-v2.md) · [Page](https://skmtc.dev/superwall/apis/superwall-api-v2/changes/v2/paywalls/:id/preview-images/get)