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

const migma = new Migma('YOUR_API_KEY');

const { data, error } = await migma.segments.list('PROJECT_ID');
{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "filters": {
        "tags": [
          "<string>"
        ],
        "status": "subscribed",
        "customFields": {}
      },
      "count": 123,
      "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

Response

Segments list

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