List subscribers | listmonk unofficial

7 parameters

pageintegeroptional

Page number to return.

per_pageintegeroptional

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

querystringoptional

SQL expression to filter subscribers.

order_bystringoptional

Field to sort by: `name`, `status`, `created_at`, or `updated_at`.

Allowed:namestatuscreated_atupdated_at

orderstringoptional

Sort direction: `ASC` or `DESC`.

Allowed:ASCDESC

subscription_statusstringoptional

Subscription status to filter by when one or more `list_id` values are provided.

list_idarray<integer>optional

List identifier to filter by. Repeat this parameter to filter by multiple lists.

1 status code

200Returns a subscriber list with the matching results, query, total count, page number, and page size.

dataobjectoptional

Error handling

page must be an integer, and per_page must be an integer or all. order_by accepts name, status, created_at, or updated_at; order accepts ASC or DESC. Each list_id value must be an integer.

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.subscribers.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",
        "email": "user@example.com",
        "name": "Example Name",
        "status": "active",
        "lists": [
          {
            "subscription_status": "example_value",
            "id": "550e8400-e29b-41d4-a716-446655440000",
            "uuid": "550e8400-e29b-41d4-a716-446655440000",
            "name": "Example Name",
            "type": "standard",
            "tags": [
              null
            ],
            "created_at": "example_value",
            "updated_at": "2026-01-15T09:00:00Z"
          }
        ]
      }
    ],
    "query": "search term",
    "total": 42,
    "per_page": 1,
    "page": 1
  }
}

Request

Response

Errors