> ## Documentation Index
> Fetch the complete documentation index at: https://docs.boostgpt.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Listmonk

> Lists, subscribers and campaigns on your own Listmonk server. Mira adds signups and drafts campaigns for you to approve.

Lists, subscribers and campaigns on your own Listmonk server. Mira adds signups and drafts campaigns for you to approve.

## Connecting

In the dashboard, open **Connectors**, find Listmonk and press **Connect**. The key you enter is checked against Listmonk before anything is saved, so a key that is refused never becomes a connection that fails later.

### What you will need

| Field | What it is |
| - | - |
| Server address | Your Listmonk address, e.g. [https://lists.example.com](https://lists.example.com) |
| API user | The API user's name |
| API token | The API user's token |
| List for Site signups | The list id new signups join |

## What your AI teammate can do with it

| Tool | What it does |
| - | - |
| `list_lists` | Lists, with subscriber counts |
| `add_subscriber` | Add a subscriber to lists |
| `list_subscribers` | Subscribers; filter with an SQL expression |
| `list_campaigns` | Campaigns |
| `get_campaign` | One campaign with views, clicks and sent counts |
| `create_campaign` | Save a new campaign as a draft. It is never sent from here. |
| `update_campaign` | Change a draft campaign. Pass every field again (get\_campaign first). |
| `start_campaign` | Start sending a draft or paused campaign now |
| `schedule_campaign` | Schedule a draft campaign for its send\_at time (set send\_at with update\_campaign first) |
| `get_campaign_views` | Views per day for campaigns |

## Useful resources

* [Listmonk API documentation](https://listmonk.app/docs/apis/apis/)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.