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

const migma = new Migma('YOUR_API_KEY');

const { data, error } = await migma.contacts.list({
  projectId: 'PROJECT_ID'
});
{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "email": "[email protected]",
      "firstName": "<string>",
      "lastName": "<string>",
      "country": "<string>",
      "language": "<string>",
      "tags": [
        "<string>"
      ],
      "customFields": {},
      "status": "active",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "error": "<string>",
  "count": 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.

Query Parameters

projectId
string
required

Project ID

page
integer
default:1

Page number for pagination

limit
integer
default:20

Number of results per page (max 100)

Required range: x <= 100
tags
string

Comma-separated tag names

status
enum<string>

Filter by contact status

Available options:
active,
unsubscribed,
bounced,
complained

Search query to filter contacts

Response

Contacts list

success
boolean
required
data
object[]
error
string | null
count
integer