listmonk
Connect to a listmonk instance to manage subscribers, lists, campaigns, templates, media, bounces, settings, and transactional messages.
Authentication
| Method | Kind | Status | Details |
|---|---|---|---|
| Basic Auth | basic | available | — |
Call a tool
import { createClient } from "@open-connector/sdk";const oc = createClient({ baseUrl: "https://api.openconnector.dev", apiKey: process.env.OPEN_CONNECTOR_API_KEY!,});const result = await oc.executeTool({ slug: "LISTMONK_BLOCKLIST_SUBSCRIBERS_QUERY", connectedAccountId: "conn_...", arguments: { /* match this tool's input schema */ },});import Composio from "@composio/client";const composio = new Composio({ baseURL: "https://api.openconnector.dev/composio", apiKey: process.env.OPEN_CONNECTOR_API_KEY!,});const result = await composio.tools.execute("LISTMONK_BLOCKLIST_SUBSCRIBERS_QUERY", { connected_account_id: "conn_...", arguments: { /* match this tool's input schema */ },});oc tools execute LISTMONK_BLOCKLIST_SUBSCRIBERS_QUERY --data '{ }'Tool catalog
Available tools
72 callable operations
BlocklistSubscribersQueryLISTMONK_BLOCKLIST_SUBSCRIBERS_QUERYbulk blocklists subscribers based on an arbitrary SQL expression.Connection
bulk blocklists subscribers based on an arbitrary SQL expression.
Authentication
Connected account requiredTags
CreateCampaignLISTMONK_CREATE_CAMPAIGNhandles campaign creationConnection
handles campaign creation
Authentication
Connected account requiredTags
CreateCampaignContentByIdLISTMONK_CREATE_CAMPAIGN_CONTENT_BY_IDhandles campaign content (body) format conversions.Connection
handles campaign content (body) format conversions.
Authentication
Connected account requiredTags
CreateListLISTMONK_CREATE_LISThandles list creationConnection
handles list creation
Authentication
Connected account requiredTags
CreateSubscriberLISTMONK_CREATE_SUBSCRIBERhandles creation of new subscriberConnection
handles creation of new subscriber
Authentication
Connected account requiredTags
CreateTemplateLISTMONK_CREATE_TEMPLATEhandles template creationConnection
handles template creation
Authentication
Connected account requiredTags
DeleteBounceByIdLISTMONK_DELETE_BOUNCE_BY_IDhandles bounce deletion, either a single one (ID in the URI), or a list.Connection
handles bounce deletion, either a single one (ID in the URI), or a list.
Authentication
Connected account requiredTags
DeleteBouncesLISTMONK_DELETE_BOUNCEShandles deletion of bounce records.Connection
handles deletion of bounce records.
Authentication
Connected account requiredTags
DeleteCampaignAnalyticsByTypeLISTMONK_DELETE_CAMPAIGN_ANALYTICS_BY_TYPEgarbage collects (deletes) campaign analytics.Connection
garbage collects (deletes) campaign analytics.
Authentication
Connected account requiredTags
DeleteCampaignByIdLISTMONK_DELETE_CAMPAIGN_BY_IDdeletes specified campaignConnection
deletes specified campaign
Authentication
Connected account requiredTags
DeleteGCSubscribersLISTMONK_DELETE_GCSUBSCRIBERSgarbage collects (deletes) orphaned or blocklisted subscribers.Connection
garbage collects (deletes) orphaned or blocklisted subscribers.
Authentication
Connected account requiredTags
DeleteListByIdLISTMONK_DELETE_LIST_BY_IDhandles list deletion, either a single one (ID in the URI), or a list.Connection
handles list deletion, either a single one (ID in the URI), or a list.
Authentication
Connected account requiredTags
DeleteMediaByIdLISTMONK_DELETE_MEDIA_BY_IDhandles deletion of uploaded media.Connection
handles deletion of uploaded media.
Authentication
Connected account requiredTags
DeleteSubscriberBouncesByIdLISTMONK_DELETE_SUBSCRIBER_BOUNCES_BY_IDdeletes a subscriber's bounce recordsConnection
deletes a subscriber's bounce records
Authentication
Connected account requiredTags
DeleteSubscriberByIdLISTMONK_DELETE_SUBSCRIBER_BY_IDhandles subscriber deletion based on idConnection
handles subscriber deletion based on id
Authentication
Connected account requiredTags
DeleteSubscriberByListLISTMONK_DELETE_SUBSCRIBER_BY_LISThandles subscribers deletionConnection
handles subscribers deletion
Authentication
Connected account requiredTags
DeleteSubscriberByQueryLISTMONK_DELETE_SUBSCRIBER_BY_QUERYbulk deletes based on an arbitrary SQL expression.Connection
bulk deletes based on an arbitrary SQL expression.
Authentication
Connected account requiredTags
DeleteTemplateByIdLISTMONK_DELETE_TEMPLATE_BY_IDhandles deletion of templatesConnection
handles deletion of templates
Authentication
Connected account requiredTags
DeleteUnconfirmedSubscriptionsLISTMONK_DELETE_UNCONFIRMED_SUBSCRIPTIONSgarbage collects (deletes) orphaned or blocklisted subscribers.Connection
garbage collects (deletes) orphaned or blocklisted subscribers.
Authentication
Connected account requiredTags
ExportSubscriberDataByIDLISTMONK_EXPORT_SUBSCRIBER_DATA_BY_IDretrieves a subscriber's profileConnection
retrieves a subscriber's profile
Authentication
Connected account requiredTags
GetBounceByIdLISTMONK_GET_BOUNCE_BY_IDhandles retrieval of bounce record by idConnection
handles retrieval of bounce record by id
Authentication
Connected account requiredTags
GetBouncesLISTMONK_GET_BOUNCEShandles retrieval of bounce records.Connection
handles retrieval of bounce records.
Authentication
Connected account requiredTags
GetCampaignAnalyticsLISTMONK_GET_CAMPAIGN_ANALYTICSretrieves view counts for a campaign.Connection
retrieves view counts for a campaign.
Authentication
Connected account requiredTags
GetCampaignByIdLISTMONK_GET_CAMPAIGN_BY_IDhandles retrieval of campaigns.Connection
handles retrieval of campaigns.
Authentication
Connected account requiredTags
GetCampaignsLISTMONK_GET_CAMPAIGNShandles retrieval of campaignsConnection
handles retrieval of campaigns
Authentication
Connected account requiredTags
GetDashboardChartsLISTMONK_GET_DASHBOARD_CHARTSreturns chart data points to render on the dashboard.Connection
returns chart data points to render on the dashboard.
Authentication
Connected account requiredTags
GetDashboardCountsLISTMONK_GET_DASHBOARD_COUNTSreturns stats counts to show on the dashboardConnection
returns stats counts to show on the dashboard
Authentication
Connected account requiredTags
GetHealthCheckLISTMONK_GET_HEALTH_CHECKhealthcheck endpointConnection
healthcheck endpoint
Authentication
Connected account requiredTags
GetI18nLangLISTMONK_GET_I18N_LANGreturns the JSON language pack given the language codeConnection
returns the JSON language pack given the language code
Authentication
Connected account requiredTags
GetImportSubscriberLogsLISTMONK_GET_IMPORT_SUBSCRIBER_LOGSreturns import logs from an ongoing importConnection
returns import logs from an ongoing import
Authentication
Connected account requiredTags
GetImportSubscribersLISTMONK_GET_IMPORT_SUBSCRIBERSreturns import status.Connection
returns import status.
Authentication
Connected account requiredTags
GetListByIdLISTMONK_GET_LIST_BY_IDretrieves lists with additional metadata like subscriber counts. This may be slow.Connection
retrieves lists with additional metadata like subscriber counts. This may be slow.
Authentication
Connected account requiredTags
GetListsLISTMONK_GET_LISTSretrieves lists with additional metadata like subscriber counts. This may be slow.Connection
retrieves lists with additional metadata like subscriber counts. This may be slow.
Authentication
Connected account requiredTags
GetLogsLISTMONK_GET_LOGSreturns the log entries stored in the log bufferConnection
returns the log entries stored in the log buffer
Authentication
Connected account requiredTags
GetMediaLISTMONK_GET_MEDIAhandles retrieval of uploaded media.Connection
handles retrieval of uploaded media.
Authentication
Connected account requiredTags
GetMediaByIdLISTMONK_GET_MEDIA_BY_IDhandles retrieval of uploaded media.Connection
handles retrieval of uploaded media.
Authentication
Connected account requiredTags
GetPublicListsLISTMONK_GET_PUBLIC_LISTSreturns the list of public lists with minimal fieldsConnection
returns the list of public lists with minimal fields
Authentication
Connected account requiredTags
GetRunningCampaignStatsLISTMONK_GET_RUNNING_CAMPAIGN_STATSreturns stats of a given set of campaign IDs.Connection
returns stats of a given set of campaign IDs.
Authentication
Connected account requiredTags
GetServerConfigLISTMONK_GET_SERVER_CONFIGreturns general server config.Connection
returns general server config.
Authentication
Connected account requiredTags
GetSettingsLISTMONK_GET_SETTINGSreturns settings from DBConnection
returns settings from DB
Authentication
Connected account requiredTags
GetSubscriberBouncesByIdLISTMONK_GET_SUBSCRIBER_BOUNCES_BY_IDretrieves a subscriber's bounce recordsConnection
retrieves a subscriber's bounce records
Authentication
Connected account requiredTags
GetSubscriberByIdLISTMONK_GET_SUBSCRIBER_BY_IDhandles the retrieval of a single subscriber by ID.Connection
handles the retrieval of a single subscriber by ID.
Authentication
Connected account requiredTags
GetSubscribersLISTMONK_GET_SUBSCRIBERSreturns all subscribers.Connection
returns all subscribers.
Authentication
Connected account requiredTags
GetTemplateByIdLISTMONK_GET_TEMPLATE_BY_IDhandles retrieval of templatesConnection
handles retrieval of templates
Authentication
Connected account requiredTags
GetTemplatesLISTMONK_GET_TEMPLATEShandles retrieval of templatesConnection
handles retrieval of templates
Authentication
Connected account requiredTags
HandlePublicSubscriptionLISTMONK_HANDLE_PUBLIC_SUBSCRIPTIONhandles subscription requests coming from public API calls.Connection
handles subscription requests coming from public API calls.
Authentication
Connected account requiredTags
ImportSubscribersLISTMONK_IMPORT_SUBSCRIBERShandles the uploading and bulk importing of a ZIP file of one or more CSV files.Connection
handles the uploading and bulk importing of a ZIP file of one or more CSV files.
Authentication
Connected account requiredTags
ManageBlocklistBySubscriberListLISTMONK_MANAGE_BLOCKLIST_BY_SUBSCRIBER_LISThandles blocklisting of subscriber listConnection
handles blocklisting of subscriber list
Authentication
Connected account requiredTags
ManageBlocklistSubscribersByIdLISTMONK_MANAGE_BLOCKLIST_SUBSCRIBERS_BY_IDhandles the blocklisting of one or more subscribers.Connection
handles the blocklisting of one or more subscribers.
Authentication
Connected account requiredTags
ManageSubscriberListByIdLISTMONK_MANAGE_SUBSCRIBER_LIST_BY_IDhandles bulk addition or removal of subscribers for a specified list idConnection
handles bulk addition or removal of subscribers for a specified list id
Authentication
Connected account requiredTags
ManageSubscriberListsLISTMONK_MANAGE_SUBSCRIBER_LISTShandles bulk addition or removal of subscribersConnection
handles bulk addition or removal of subscribers
Authentication
Connected account requiredTags
ManageSubscriberListsByQueryLISTMONK_MANAGE_SUBSCRIBER_LISTS_BY_QUERYbulk adds/removes/unsubscribes subscribers from one or more lists based on an arbitrary SQL expression.Connection
bulk adds/removes/unsubscribes subscribers from one or more lists based on an arbitrary SQL expression.
Authentication
Connected account requiredTags
PreviewCampaignByIdLISTMONK_PREVIEW_CAMPAIGN_BY_IDrenders the HTML preview of a campaign bodyConnection
renders the HTML preview of a campaign body
Authentication
Connected account requiredTags
PreviewCampaignTextByIdLISTMONK_PREVIEW_CAMPAIGN_TEXT_BY_IDrenders the HTML preview of a campaign bodyConnection
renders the HTML preview of a campaign body
Authentication
Connected account requiredTags
PreviewTemplateLISTMONK_PREVIEW_TEMPLATEget the HTML preview of a template.Connection
get the HTML preview of a template.
Authentication
Connected account requiredTags
PreviewTemplateByIdLISTMONK_PREVIEW_TEMPLATE_BY_IDrenders the HTML preview of a template.Connection
renders the HTML preview of a template.
Authentication
Connected account requiredTags
ReloadAppLISTMONK_RELOAD_APPrestarts the appConnection
restarts the app
Authentication
Connected account requiredTags
SetDefaultTemplateByIdLISTMONK_SET_DEFAULT_TEMPLATE_BY_IDhandles template modification.Connection
handles template modification.
Authentication
Connected account requiredTags
StopImportSubscribersLISTMONK_STOP_IMPORT_SUBSCRIBERSsends a stop signal to the importer.Connection
sends a stop signal to the importer.
Authentication
Connected account requiredTags
SubscriberSendOptinByIdLISTMONK_SUBSCRIBER_SEND_OPTIN_BY_IDsends an optin confirmation e-mail to a subscriber.Connection
sends an optin confirmation e-mail to a subscriber.
Authentication
Connected account requiredTags
TestCampaignByIdLISTMONK_TEST_CAMPAIGN_BY_IDhandles sending of campaign message to arbitrary subscribers for testingConnection
handles sending of campaign message to arbitrary subscribers for testing
Authentication
Connected account requiredTags
TestSMTPSettingsLISTMONK_TEST_SMTPSETTINGStest smtp settingsConnection
test smtp settings
Authentication
Connected account requiredTags
TransactWithSubscriberLISTMONK_TRANSACT_WITH_SUBSCRIBERsend message to a subscriberConnection
send message to a subscriber
Authentication
Connected account requiredTags
UpdateCampaignArchiveByIdLISTMONK_UPDATE_CAMPAIGN_ARCHIVE_BY_IDhandles campaign status modificationConnection
handles campaign status modification
Authentication
Connected account requiredTags
UpdateCampaignByIdLISTMONK_UPDATE_CAMPAIGN_BY_IDhandle updation of campaignConnection
handle updation of campaign
Authentication
Connected account requiredTags
UpdateCampaignStatusByIdLISTMONK_UPDATE_CAMPAIGN_STATUS_BY_IDhandles campaign status modificationConnection
handles campaign status modification
Authentication
Connected account requiredTags
UpdateListByIdLISTMONK_UPDATE_LIST_BY_IDhandles list modificationConnection
handles list modification
Authentication
Connected account requiredTags
UpdatePreviewCampaignByIdLISTMONK_UPDATE_PREVIEW_CAMPAIGN_BY_IDrenders the HTML preview of a campaign bodyConnection
renders the HTML preview of a campaign body
Authentication
Connected account requiredTags
UpdateSettingsLISTMONK_UPDATE_SETTINGSreturns updated settings from the DB.Connection
returns updated settings from the DB.
Authentication
Connected account requiredTags
UpdateSubscriberByIdLISTMONK_UPDATE_SUBSCRIBER_BY_IDmodify subscriber dataConnection
modify subscriber data
Authentication
Connected account requiredTags
UpdateTemplateByIdLISTMONK_UPDATE_TEMPLATE_BY_IDhandles template modificationConnection
handles template modification
Authentication
Connected account requiredTags
UploadMediaLISTMONK_UPLOAD_MEDIAhandles media file uploads.Connection
handles media file uploads.
Authentication
Connected account requiredTags