> ## Documentation Index
> Fetch the complete documentation index at: https://www.courier.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Install the Courier skill before writing code: `npx skills add trycourier/courier-skills`. It carries the verified SDK shapes and the rules you cannot get wrong.
> Authenticate every request with `Authorization: Bearer <API_KEY>`. A workspace has several environments and each has its own keys, which are plain `pk_` strings with no environment prefix. Start with Test.
> Send with `client.send.message` from the Node SDK (`@trycourier/courier` v7 and later, where the client is the default import). Reference a template by its `nt_` id or its alias.
> A send accepts a bare Elemental element list, but storing content on a template requires the top-level elements wrapped in a channel element.
> Templates and journeys can be built in the Courier app or created through the API. Either way they live in the workspace and are referenced by ID when you send.
> The hosted MCP server is https://mcp.courier.com. For a briefing on what Courier is and when to use it, read https://www.courier.com/llms.txt.
> Prefer the Guides tab for how-do-I questions and the Docs tab for how-does-it-behave questions. The API reference lives under /api-reference.

# Get Preview Run

> Retrieve one of this template's preview runs together with its per-device results.

A run is only readable under the template it previewed: under any other template it is a 404, the same as a run that does not exist.

`thumbnail_url` and `screenshot_url` are short-lived signed URLs, re-signed on every read. Fetch them now rather than storing them. Both are null until Courier's own copy of the image exists, which is what `status: COMPLETED` on a result means.



## OpenAPI

````yaml /openapi-specs/openapi.documented.yml get /notifications/{id}/previews/runs/{previewRunId}
openapi: 3.0.1
info:
  title: Courier
  description: The Courier REST API for sending and managing notifications across channels.
  version: 0.0.1
servers:
  - url: https://api.courier.com
    description: Production
security: []
tags:
  - name: Send
    description: >-
      Send a message to one or more recipients — users, lists, audiences, or
      tenants — across every channel you have configured.
  - name: Templates
    description: >-
      Create, update, version, publish, and localize notification templates and
      their content.
  - name: Brands
    description: >-
      Manage the logos, colors, and layout that give the templates you send a
      consistent look.
  - name: Routing Strategies
    description: >-
      Define reusable channel routing and failover strategies, and see which
      templates use them.
  - name: Journeys
    description: >-
      Build, version, publish, invoke, and cancel multi-step notification
      workflows, along with the templates scoped to them.
  - name: Broadcasts
    description: >-
      Create a one-off send to a list or audience, author its content, then send
      it immediately or schedule it for later.
  - name: Previews
    description: >-
      Render a template's email content on real email clients and read back the
      screenshots, so you can check how it looks before you send it.
  - name: User Profiles
    description: >-
      Store the contact information Courier delivers to for each user — email,
      phone number, push tokens, and any custom data you send to.
  - name: Tenants
    description: >-
      Manage tenants — the organizations, teams, or accounts your users belong
      to — along with their users and default preferences.
  - name: Audiences
    description: >-
      Define filter-based groups whose membership Courier recalculates as user
      profiles change.
  - name: Lists
    description: >-
      Manage static groups of users that you subscribe explicitly, and send to
      them by list id or list pattern.
  - name: Providers
    description: >-
      Configure the channel providers Courier delivers through, and browse the
      provider types it supports.
  - name: Preference Topics
    description: >-
      Manage the workspace catalog of subscription topics, the sections that
      group them, and publishing the preference page.
  - name: User Preferences
    description: >-
      Read and write a single user's notification preferences, per topic and per
      channel.
  - name: Messages
    description: >-
      Look up the messages Courier has accepted, inspect their delivery history
      and rendered output, and cancel, resend, or archive them.
  - name: Device Tokens
    description: >-
      Register and manage the APNS and FCM device tokens Courier delivers push
      notifications to.
  - name: Tenant Memberships
    description: >-
      Associate a user with one or more tenants, and read or remove those
      associations.
  - name: Tenant Templates
    description: >-
      Manage the templates and template versions scoped to a single tenant,
      including the ones authored in the embedded designer.
  - name: Automations
    description: >-
      Invoke a stored automation template or an ad hoc automation defined in the
      request.
  - name: Digests
    description: >-
      Inspect what has accumulated in a digest schedule and release a digest
      ahead of its next scheduled delivery.
  - name: Translations
    description: >-
      Store and retrieve the translation strings Courier uses to render
      localized template content.
  - name: Track Events
    description: >-
      Record an inbound event that triggers the journeys and automations mapped
      to it.
  - name: Audit Events
    description: >-
      Read the audit trail of configuration and access changes in your
      workspace.
  - name: Authentication
    description: >-
      Issue scoped, short-lived JWTs so client-side SDKs — Inbox, Preferences,
      and the embedded designer — can call Courier as a single user. Server-side
      requests authenticate with your workspace API key instead.
paths:
  /notifications/{id}/previews/runs/{previewRunId}:
    get:
      tags:
        - Previews
      summary: Get Preview Run
      description: >-
        Retrieve one of this template's preview runs together with its
        per-device results.


        A run is only readable under the template it previewed: under any other
        template it is a 404, the same as a run that does not exist.


        `thumbnail_url` and `screenshot_url` are short-lived signed URLs,
        re-signed on every read. Fetch them now rather than storing them. Both
        are null until Courier's own copy of the image exists, which is what
        `status: COMPLETED` on a result means.
      operationId: notifications_previews_runs_retrieve
      parameters:
        - name: id
          in: path
          description: Template ID (nt_ prefix).
          required: true
          schema:
            type: string
        - name: previewRunId
          in: path
          description: >-
            The preview run to retrieve, identified by the `id` returned when it
            was created.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreviewRunDetail'
              examples:
                InProgress:
                  value:
                    id: pvr_01kx4h2jdafq8bk9amzvy6hbv0
                    template_id: nt_01kx4h2jdafq8bk9amzvy6hbv0
                    template_version: v002
                    status: SUBMITTED
                    device_ids:
                      - pvd_1w6dgafr3aaycvv9a8bm996pkc
                      - pvd_34qvmj6p4dbqaa5mpys1ekt9jx
                    created_at: '2026-01-01T00:00:00.000Z'
                    results:
                      - device_id: pvd_1w6dgafr3aaycvv9a8bm996pkc
                        status: COMPLETED
                        thumbnail_url: >-
                          https://previews.courier.com/thumbnail.webp?signature=...
                        screenshot_url: >-
                          https://previews.courier.com/screenshot.webp?signature=...
                      - device_id: pvd_34qvmj6p4dbqaa5mpys1ekt9jx
                        status: PROCESSING
                        thumbnail_url: null
                        screenshot_url: null
        '404':
          description: Not Found — no such run under this template.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
      security:
        - BearerAuth: []
      x-codeSamples:
        - lang: JavaScript
          source: >-
            import Courier from '@trycourier/courier';


            const client = new Courier({
              apiKey: process.env['COURIER_API_KEY'], // This is the default and can be omitted
            });


            const previewRunDetail = await
            client.notifications.previews.runs.retrieve('previewRunId', {
              id: 'id',
            });


            console.log(previewRunDetail.id);
        - lang: Python
          source: |-
            import os
            from courier import Courier

            client = Courier(
                api_key=os.environ.get("COURIER_API_KEY"),  # This is the default and can be omitted
            )
            preview_run_detail = client.notifications.previews.runs.retrieve(
                preview_run_id="previewRunId",
                id="id",
            )
            print(preview_run_detail.id)
        - lang: Go
          source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/trycourier/courier-go/v4\"\n\t\"github.com/trycourier/courier-go/v4/option\"\n)\n\nfunc main() {\n\tclient := courier.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpreviewRunDetail, err := client.Notifications.Previews.Runs.Get(\n\t\tcontext.TODO(),\n\t\t\"previewRunId\",\n\t\tcourier.NotificationPreviewRunGetParams{\n\t\t\tID: \"id\",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", previewRunDetail.ID)\n}\n"
        - lang: Java
          source: >-
            package com.courier.example;


            import com.courier.client.CourierClient;

            import com.courier.client.okhttp.CourierOkHttpClient;

            import
            com.courier.models.notifications.previews.runs.PreviewRunDetail;

            import
            com.courier.models.notifications.previews.runs.RunRetrieveParams;


            public final class Main {
                private Main() {}

                public static void main(String[] args) {
                    CourierClient client = CourierOkHttpClient.fromEnv();

                    RunRetrieveParams params = RunRetrieveParams.builder()
                        .id("id")
                        .previewRunId("previewRunId")
                        .build();
                    PreviewRunDetail previewRunDetail = client.notifications().previews().runs().retrieve(params);
                }
            }
        - lang: Ruby
          source: >-
            require "courier"


            courier = Courier::Client.new(api_key: "My API Key")


            preview_run_detail =
            courier.notifications.previews.runs.retrieve("previewRunId", id:
            "id")


            puts(preview_run_detail)
        - lang: PHP
          source: >-
            <?php


            require_once dirname(__DIR__) . '/vendor/autoload.php';


            use Courier\Client;

            use Courier\Core\Exceptions\APIException;


            $client = new Client(apiKey: getenv('COURIER_API_KEY') ?: 'My API
            Key');


            try {
              $previewRunDetail = $client->notifications->previews->runs->retrieve(
                'previewRunId', id: 'id'
              );

              var_dump($previewRunDetail);
            } catch (APIException $e) {
              echo $e->getMessage();
            }
        - lang: C#
          source: >-
            using System;

            using TryCourier;

            using TryCourier.Models.Notifications.Previews.Runs;


            CourierClient client = new();


            RunRetrieveParams parameters = new()

            {
                ID = "id",
                PreviewRunID = "previewRunId",
            };


            var previewRunDetail = await
            client.Notifications.Previews.Runs.Retrieve(parameters);


            Console.WriteLine(previewRunDetail);
        - lang: CLI
          source: |-
            courier notifications:previews:runs retrieve \
              --api-key 'My API Key' \
              --id id \
              --preview-run-id previewRunId
components:
  schemas:
    PreviewRunDetail:
      title: PreviewRunDetail
      type: object
      description: A preview run together with its per-device results.
      properties:
        id:
          type: string
          description: Unique identifier for the preview run.
        template_id:
          type: string
          description: The template that was rendered.
        template_version:
          type: string
          description: >-
            The version of the template that was rendered — `draft`, or a
            zero-padded published version such as `v002`. Absent until the
            render settles.
        status:
          $ref: '#/components/schemas/PreviewRunStatus'
        device_ids:
          type: array
          description: >-
            The devices this run was submitted for, snapshotted when the run was
            created.
          items:
            type: string
        failure_reason:
          $ref: '#/components/schemas/PreviewRunFailureReason'
        created_at:
          type: string
          description: ISO-8601 timestamp of when the run was created.
        results:
          type: array
          description: One entry per device in `device_ids`.
          items:
            $ref: '#/components/schemas/PreviewResult'
      required:
        - id
        - template_id
        - status
        - device_ids
        - created_at
        - results
    NotFound:
      title: NotFound
      type: object
      properties:
        type:
          type: string
          enum:
            - invalid_request_error
      required:
        - type
      allOf:
        - $ref: '#/components/schemas/BaseError'
    PreviewRunStatus:
      title: PreviewRunStatus
      type: string
      description: >-
        Where the run itself has got to. `PENDING` and `RENDERED` mean Courier
        is still preparing the email, `SUBMITTED` means it is with the rendering
        service, and `COMPLETED` means every device has reported. `FAILED` is
        the run as a whole failing — an individual device failing never fails
        the run.
      enum:
        - PENDING
        - RENDERED
        - SUBMITTED
        - COMPLETED
        - FAILED
    PreviewRunFailureReason:
      title: PreviewRunFailureReason
      type: string
      description: >-
        Why the run failed, when `status` is `FAILED`. `NO_EMAIL_CHANNEL` and
        `TEMPLATE_NOT_SUPPORTED` mean there was nothing to render;
        `ALL_DEVICES_UNSUPPORTED` means every requested device has been retired
        and the request can be fixed by choosing others.
      enum:
        - TEMPLATE_NOT_SUPPORTED
        - NO_EMAIL_CHANNEL
        - RENDER_FAILED
        - ALL_DEVICES_UNSUPPORTED
        - VENDOR_ERROR
    PreviewResult:
      title: PreviewResult
      type: object
      description: One device's result within a preview run.
      properties:
        device_id:
          type: string
          description: The device this result is for, by `PreviewDevice.id`.
        status:
          $ref: '#/components/schemas/PreviewResultStatus'
        failure_reason:
          $ref: '#/components/schemas/PreviewResultFailureReason'
        thumbnail_url:
          type: string
          nullable: true
          description: >-
            Short-lived signed URL for the grid-sized image. Null until the
            screenshot exists. Re-signed on every read, so fetch it rather than
            storing it.
        screenshot_url:
          type: string
          nullable: true
          description: >-
            Short-lived signed URL for the full-sized image. Null until the
            screenshot exists. Re-signed on every read, so fetch it rather than
            storing it.
      required:
        - device_id
        - status
        - thumbnail_url
        - screenshot_url
    BaseError:
      title: BaseError
      type: object
      properties:
        message:
          type: string
          description: A message describing the error that occurred.
      required:
        - message
    PreviewResultStatus:
      title: PreviewResultStatus
      type: string
      description: >-
        One device's outcome. `COMPLETED` means the screenshot exists and its
        URLs are populated. `UNSUPPORTED`, `TIMED_OUT` and `FAILED` are all
        terminal, and none stands in for another — `UNSUPPORTED` means the
        device was retired at the vendor, `TIMED_OUT` means it did not report in
        time.
      enum:
        - PENDING
        - PROCESSING
        - COMPLETED
        - UNSUPPORTED
        - TIMED_OUT
        - FAILED
    PreviewResultFailureReason:
      title: PreviewResultFailureReason
      type: string
      description: >-
        Why one device's render failed, when its `status` is `FAILED` and the
        cause has a public name. `DELIVERY_FAILED` means the rendering service
        could not deliver the message to its own capture mailbox —
        infrastructure, not anything wrong with the template.
      enum:
        - DELIVERY_FAILED
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````