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

const migma = new Migma('YOUR_API_KEY');

const { data, error } = await migma.projects.list();
{
  "success": true,
  "data": {
    "projects": [
      {
        "_id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "status": "pending",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "domain": "<string>",
        "logoUrls": {
          "primary": "<string>",
          "secondary": "<string>",
          "favicon": "<string>"
        },
        "screenshotUrl": "<string>",
        "email_create_suggestions": [
          "<string>"
        ]
      }
    ],
    "pagination": {
      "total": 123,
      "limit": 123,
      "offset": 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

limit
integer<int32>
default:20

The maximum number of results to return (max 100)

offset
integer<int32>
default:0

The number of items to skip before starting to collect the result set

status
string

Filter by project status (pending|processing|active|error)

Response

Projects list response

success
boolean
required
data
object
error
string | null