List mailing lists | listmonk unofficial

7 parameters

pageintegeroptional

The page of results to retrieve.

per_pageintegeroptional

The number of results per page, or `all` to return all results without pagination.

querystringoptional

A string used to search lists by name.

order_bystringoptional

The field to sort results by: name, status, created_at, or updated_at.

Allowed:namestatuscreated_atupdated_at

orderstringoptional

The sort direction: ASC or DESC.

Allowed:ASCDESC

minimalbooleanoptional

Set to true to return a response without body content.

tagarray<string>optional

A tag to filter lists by; repeat this query parameter to filter by multiple tags.

1 status code

200Returns list metadata, including matching results, the total result count, and pagination details.

dataobjectoptional

Error handling

order_by must be one of name, status, created_at, or updated_at, and order must be ASC or DESC. per_page accepts an integer or all to return results without pagination.

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.list({
  page: 1,
  perPage: 20,
  query: "keyword",
  orderBy: "example",
  order: "example",
});

{
  "data": {
    "results": [
      {
        "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"
      }
    ],
    "total": 42,
    "per_page": 1,
    "page": 1
  }
}

Request

Response

Errors