Export a subscriber's data | listmonk unofficial

1 parameter

idintegerrequired

The numeric identifier of the subscriber whose profile and related data you want to export.

1 status code

200Returns an object containing the subscriber's email, profile details, subscriptions, campaign views, and link clicks.

emailstringoptional

profilearray<object>optional

subscriptionsarray<object>optional

campaign_viewsarray<object>optional

link_clicksarray<object>optional

Error handling

The id path parameter must be the numeric identifier of the subscriber whose data you want to export.

import { Client } from "listmonk-unofficial-sdk";

const client = new Client({
  baseUrl: "http://localhost:9000/api",
  auth: {
    username: process.env.API_USER,
    password: process.env.API_PASS,
  },
});

const result = await client.export.list({ id: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "email": "user@example.com",
  "profile": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "uuid": "550e8400-e29b-41d4-a716-446655440000",
      "email": "user@example.com",
      "name": "Example Name",
      "status": "active",
      "created_at": "example_value",
      "updated_at": "2026-01-15T09:00:00Z"
    }
  ],
  "subscriptions": [
    {
      "subscription_status": "example_value",
      "name": "Example Name",
      "type": "standard",
      "created_at": "example_value"
    }
  ],
  "campaign_views": [
    {}
  ],
  "link_clicks": [
    {}
  ]
}

Request

Response

Errors