---
title: "Read a preview"
method: GET
path: "/api/v1/preview/{previewId}"
tags: ["API Reference"]
---

# Read a preview

`GET /api/v1/preview/{previewId}`

## Request

- Base URL: `https://revnu.com`
- URL: `https://revnu.com/api/v1/preview/{previewId}`
- Auth: none required

Where the research is (researching, ready, failed, claimed or expired), the review rows with their sources once ready, and the claim_url that turns the research into an account.

## Path parameters

- `previewId` string, required

## Response `200`

{ preview } in any status but expired.

- object
  - `preview` union, required
    - object
      - `status` 'claimed', required
      - `next` string, required
      - `previewId` string, required
      - `website` string, required
      - `businessName` string, required
      - `expiresAt` string, required
    - object
      - `status` 'expired', required
      - `next` string, required
      - `previewId` string, required
      - `website` string, required
      - `businessName` string, required
      - `expiresAt` string, required
    - object
      - `status` 'failed', required
      - `claim_url` string, required
      - `next` string, required
      - `previewId` string, required
      - `website` string, required
      - `businessName` string, required
      - `expiresAt` string, required
    - object
      - `status` 'ready', required
      - `claim_url` string, required
      - `review` object, required
        - `findings` string[], required
        - `rows` object[], required
          - `found` string, required
          - `sources` string[], required
          - `question` string
          - `id` string, required
          - `kind` 'fact' | 'question' | 'value', required
          - `label` string, required
      - `next` string, required
      - `previewId` string, required
      - `website` string, required
      - `businessName` string, required
      - `expiresAt` string, required
    - object
      - `status` 'researching', required
      - `claim_url` string, required
      - `research` object, required
        - `step` string, nullable, required
        - `findings` string[], required
      - `next` string, required
      - `previewId` string, required
      - `website` string, required
      - `businessName` string, required
      - `expiresAt` string, required

## Other responses

- `404`: not_found: no preview has that id. Expired previews are deleted daily, so an old id ends up here too.
- `410`: The preview expired. The body still says so in preview.status.

---

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