Skip to main content
GET
/
v1
/
emails
/
previews
/
{previewId}
/
status
Node.js SDK
import Migma from 'migma';

const migma = new Migma('YOUR_API_KEY');

const { data, error } = await migma.previews.getStatus('PREVIEW_ID');
{
  "success": true,
  "data": {
    "previewId": "<string>",
    "status": "<string>",
    "metadata": {
      "requestedDevices": 123,
      "completedDevices": 123,
      "failedDevices": 123
    }
  }
}

Authorizations

Authorization
string
header
required

API key authentication. Use 'Authorization: Bearer YOUR_API_KEY' where YOUR_API_KEY is obtained from the Migma dashboard under Settings → API Integration.

Path Parameters

previewId
string
required

Preview ID

Response

Status retrieved

success
boolean
data
object