Get server settings | listmonk unofficial

1 status code

200Returns a settings object containing the stored configuration values.

dataobjectoptional

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.settings.list();

{
  "data": {
    "app.site_name": "Example Name",
    "app.root_url": "https://example.com",
    "app.logo_url": "https://example.com",
    "app.favicon_url": "https://example.com",
    "app.from_email": "user@example.com",
    "app.notify_emails": [
      "user@example.com"
    ],
    "app.enable_public_subscription_page": true,
    "app.enable_public_archive": true,
    "app.send_optin_confirmation": true,
    "app.check_updates": true,
    "app.lang": "example_value",
    "app.batch_size": 1,
    "app.concurrency": 1,
    "app.max_send_errors": 1,
    "app.message_rate": 1,
    "app.message_sliding_window": true,
    "app.message_sliding_window_duration": "example_value",
    "app.message_sliding_window_rate": 1,
    "privacy.individual_tracking": true,
    "privacy.unsubscribe_header": true,
    "privacy.allow_blocklist": true,
    "privacy.allow_preferences": true,
    "privacy.allow_export": true,
    "privacy.allow_wipe": true,
    "privacy.exportable": [
      "example_value"
    ],
    "privacy.domain_blocklist": [
      {}
    ],
    "upload.provider": "example_value",
    "upload.filesystem.upload_path": "example_value",
    "upload.filesystem.upload_uri": "example_value",
    "upload.s3.url": "https://example.com",
    "upload.s3.public_url": "https://example.com",
    "upload.s3.aws_access_key_id": "550e8400-e29b-41d4-a716-446655440000",
    "upload.s3.aws_default_region": "example_value",
    "upload.s3.bucket": "example_value",
    "upload.s3.bucket_domain": "example_value",
    "upload.s3.bucket_path": "example_value",
    "upload.s3.bucket_type": "example_value",
    "upload.s3.expiry": "example_value",
    "smtp": [
      {
        "uuid": "550e8400-e29b-41d4-a716-446655440000",
        "enabled": true,
        "host": "example_value",
        "hello_hostname": "Example Name",
        "port": 1,
        "auth_protocol": "example_value",
        "username": "janedoe",
        "email_headers": [
          {}
        ],
        "max_conns": 1,
        "max_msg_retries": 1,
        "idle_timeout": "2026-01-15T09:00:00Z",
        "wait_timeout": "2026-01-15T09:00:00Z",
        "tls_type": "example_value",
        "tls_skip_verify": true
      }
    ],
    "messengers": [
      {}
    ],
    "bounce.enabled": true,
    "bounce.webhooks_enabled": true,
    "bounce.count": 42,
    "bounce.action": "example_value",
    "bounce.ses_enabled": true,
    "bounce.azure.enabled": true,
    "bounce.azure.shared_secret": "example_value",
    "bounce.azure.shared_secret_header": "example_value",
    "bounce.sendgrid_enabled": true,
    "bounce.sendgrid_key": "example_key_abc123",
    "bounce.forwardemail_enabled": true,
    "bounce.forwardemail_key": "user@example.com",
    "bounce.postmark_enabled": true,
    "bounce.postmark_username": "Example Name",
    "bounce.postmark_password": "example_value",
    "bounce.mailboxes": [
      {
        "uuid": "550e8400-e29b-41d4-a716-446655440000",
        "enabled": true,
        "type": "standard",
        "host": "example_value",
        "port": 1,
        "auth_protocol": "example_value",
        "return_path": "example_value",
        "username": "janedoe",
        "tls_enabled": true,
        "tls_skip_verify": true,
        "scan_interval": "example_value"
      }
    ],
    "appearance.admin.custom_css": "example_value",
    "appearance.admin.custom_js": "example_value",
    "appearance.public.custom_css": "example_value",
    "appearance.public.custom_js": "example_value"
  }
}

Response