---
title: "Preview the pages for any app on the App Store"
method: POST
path: "/preview"
tags: ["Preview"]
---

# Preview the pages for any app on the App Store

`POST /preview`

## Request

- Base URL: `https://pagefully.com/api/v1`
- URL: `https://pagefully.com/api/v1/preview`
- Auth: none required

No token. The pages Pagefully would plan for the app and the first one designed, as the site shows at `preview_url`. Made once for an app and kept: asking again serves what is kept, or says how far the one being made has got. Limited by visitor and by day, as on the site.

## Request body

- union
  - object
    - `app_store_url` string, required: The app's address on the App Store, which ends in id and a number.
    - `app_store_id` string: Apple's id for the app: that number.
  - object
    - `app_store_url` string: The app's address on the App Store, which ends in id and a number.
    - `app_store_id` string, required: Apple's id for the app: that number.

## Response `200`

The preview, ready, stopped by a limit, or failed. `message` says which and why.

- Preview
  - `app` object, required
    - `app_store_id` string, required
    - `name` string, required
  - `state` 'making' | 'ready' | 'stopped' | 'failed', required
  - `message` string, nullable, required
  - `steps` object[], required
    - `key` string, required
    - `label` string, required
    - `state` string, required
  - `pages` object[], nullable, required
    - `kind` string, required
    - `name` string, required
    - `message` string, required
    - `searches` string[], required
    - `reason` string, required
  - `design` object, nullable, required: The one page designed: which of `pages` it is, its promotional text, and its shots, each with headline, subline and links to the original and the drawn screenshot at display size (good for ten minutes).
  - `preview_url` string, required: The preview on the site.

## Other responses

- `202`: Being made. Ask again in a few seconds.
- `400`: The request could not be read: a body that is not a JSON object, or a field missing or of the wrong kind.
- `404`: No such app on the App Store.

---

[API](https://skmtc.dev/pagefully/apis/pagefully-api.md) · [All operations](https://skmtc.dev/pagefully/apis/pagefully-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pagefully/apis/pagefully-api/revisions/60e17ce09d31?raw)