Skip to main content
GET
/
v1
/
projects
/
emails
Node.js SDK
import Migma from 'migma';

const migma = new Migma('YOUR_API_KEY');

const { data, error } = await migma.emails.list({
  projectId: 'PROJECT_ID',
  limit: 10,
  status: 'completed'
});
{
  "success": true,
  "data": {
    "emails": [
      {
        "conversationId": "<string>",
        "title": "<string>",
        "subject": "<string>",
        "previewText": "<string>",
        "status": "pending",
        "screenshotUrl": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "pagination": {
      "total": 123,
      "page": 123,
      "limit": 123,
      "hasMore": true
    }
  },
  "error": "<string>"
}

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.

Query Parameters

projectId
string
required

Project ID to list emails for

limit
integer<int32>
default:20

Maximum number of results (1-100)

Required range: 1 <= x <= 100
page
integer<int32>
default:1

Page number

Required range: x >= 1
status
enum<string>

Filter by generation status

Available options:
pending,
processing,
completed,
failed

Search by title or subject

Response

List of emails

success
boolean
required
data
object
error
string | null