---
title: "Get app preview information"
method: GET
path: "/api/v3/previews/{preview_id}"
tags: ["App Previews"]
---

# Get app preview information

`GET /api/v3/previews/{preview_id}`

## Request

- Base URL: `https://codemagic.io`
- URL: `https://codemagic.io/api/v3/previews/{preview_id}`
- Auth: API key in header `x-auth-token`
- TypeScript: <https://skmtc.dev/codemagic/apis/codemagic-api/docs/api/v3/previews/:preview_id/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `preview_id` string, required

## Response `200`

Request fulfilled, document follows

- AppPreviewSchemaNoPagination
  - `data` PreviewsSchemasAppPreviewSchema, required
    - `id` string, required
    - `streaming_public_key` string, required
    - `platform` 'android' | 'ios', required: Mobile platform an app preview runs on.
    - `app` ApplicationRef, required
      - `id` string, required
      - `name` string, required
      - `icon_url` string, nullable, required: URL of the application icon, if there is one.
    - `build` PreviewBuild, required
      - `id` string, required
      - `release_notes` ReleaseNote[], required
        - `language` string, required
        - `text` string, required
      - `labels` string[], required: Labels attached to the build.
    - `artifact` PreviewArtifact, required
      - `name` string, required: File name of the artifact.
      - `path` string, required: Path that identifies the artifact within its build.
      - `version_code` string, nullable, required: Version code of the app in the artifact, if known.
      - `version_name` string, nullable, required: Version name of the app in the artifact, if known.
    - `created_at` string, date-time, required
    - `expires_at` string, date-time, required
    - `deleted_at` string, date-time, nullable, required

## Other responses

- `400`: The request could not be validated
- `401`: Authentication is missing or invalid
- `403`: The caller lacks the required permission
- `404`: The requested resource does not exist
- `429`: The rate limit has been exceeded

---

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