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'
});
migma emails list --project PROJECT_ID --limit 10 --status completed --json
import requests

url = "https://api.migma.ai/v1/projects/emails"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.migma.ai/v1/projects/emails",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.migma.ai/v1/projects/emails"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.migma.ai/v1/projects/emails")
.header("Authorization", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.migma.ai/v1/projects/emails")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": {
    "emails": [
      {
        "conversationId": "<string>",
        "title": "<string>",
        "subject": "<string>",
        "previewText": "<string>",
        "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 → Developers → API Keys.

Query Parameters

projectId
string
required

Project ID to list emails for

Pattern: ^[0-9a-fA-F]{24}$
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