Skip to content

Knuckles-Team/listmonk-api

Repository files navigation

Listmonk API

PyPI - Version PyPI - Downloads GitHub Repo stars GitHub forks GitHub contributors PyPI - License GitHub

GitHub last commit (by committer) GitHub pull requests GitHub closed pull requests GitHub issues

GitHub top language GitHub language count GitHub repo size GitHub repo file count (file type) PyPI - Wheel PyPI - Implementation

Version: 0.3.1

Listmonk API Python Wrapper

This repository is actively maintained - Contributions are welcome!

API Calls:

  • Subscribers
  • Lists
  • Import
  • Campaigns
  • Media
  • Templates
  • Transactional
Usage:
#!/usr/bin/python
# coding: utf-8
import listmonk_api

username = "<LISTMONK USERNAME>"
password = "<LISTMONK_PASSWORD>"
listmonk_api_url = "<LISTMONK_URL>"
client = listmonk_api.Api(url=listmonk_api_url, username=username, password=password)

lists = client.get_lists()
print(f"Lists: {lists}")

created_list = client.create_list(name="EXAMPLE TEMPLATE", type="<public/private>", optin="<single/double>", tags=['<LIST TAG>'])
print(f"Created List: {created_list}")

created_campaign = client.create_campaign(name="EXAMPLE TEMPLATE", type="<public/private>", optin="<single/double>", tags=['<LIST TAG>'])
print(f"Created Campaign: {created_campaign}")

print(f"Subscribers: {client.get_subscribers()}")

print(f"Campaigns: {client.get_campaigns()}")
Installation Instructions:

Install Python Package

python -m pip install listmonk-api
Repository Owners:

GitHub followers GitHub User's stars