Get a mailing list | listmonk unofficial

1 parameter

list_idintegerrequired

The integer ID of the mailing list to retrieve.

1 status code

200Returns the mailing list object, including its identifier, timestamps, UUID, settings, tags, subscriber count, and description.

dataobjectoptional

Error handling

The list_id path parameter must be an integer identifying the list to retrieve. Use the list's ID in the URI.

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.lists.get({ listId: "c0a80123-4567-89ab-cdef-0123456789ab" });

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "created_at": "example_value",
    "updated_at": "2026-01-15T09:00:00Z",
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Example Name",
    "type": "standard",
    "optin": "example_value",
    "tags": [
      "example_value"
    ],
    "subscriber_count": 42,
    "description": "Example description"
  }
}

Request

Response

Errors