How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

listmonk Subscribers API

The Subscribers API from listmonk — 10 operation(s) for subscribers.

listmonk Subscribers API is one of 14 APIs that listmonk publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Subscribers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 23 operations across 16 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: http://localhost:9000/api, {host}/api.

23 operations 16 paths 13 schemas 4 DELETE6 GET4 POST9 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://{listmonk_host}/api
Authentication
HTTP Basic, API Key
Resource Areas
1

Authentication & Security 2

listmonk Subscribers API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). An API key is passed in the header as Authorization (TokenAuth).

  • BasicAuth — HTTP Basic auth using an API user name and token (apiuser:token).
  • TokenAuth — Authorization header in the form: token apiuser:token.

Paths & Operations 23

Across 16 paths, the API surfaces 23 operations — 4 DELETE, 6 GET, 4 POST, 9 PUT. Each is listed below with its method, path, parameters, and response codes.

Subscribers 23

Subscribers API

GET
/subscribers
returns all subscribers.
getSubscribers 7 params → 200
POST
/subscribers
handles creation of new subscriber
createSubscriber body → 200
DELETE
/subscribers
handles subscribers deletion
deleteSubscriberByList 1 param → 200
GET
/subscribers/{id}
handles the retrieval of a single subscriber by ID.
getSubscriberById 1 param → 200
PUT
/subscribers/{id}
modify subscriber data
updateSubscriberById 1 param body → 200
DELETE
/subscribers/{id}
handles subscriber deletion based on id
deleteSubscriberById 1 param → 200
PUT
/subscribers/lists
handles bulk addition or removal of subscribers
manageSubscriberLists body → 200
PUT
/subscribers/lists/{id}
handles bulk addition or removal of subscribers for a specified list id
manageSubscriberListById 1 param body → 200
PUT
/subscribers/blocklist
handles blocklisting of subscriber list
manageBlocklistBySubscriberList body → 200
PUT
/subscribers/{id}/blocklist
handles the blocklisting of one or more subscribers.
manageBlocklistSubscribersById 1 param body → 200
GET
/subscribers/{id}/export
retrieves a subscriber's profile
exportSubscriberDataByID 1 param → 200
GET
/subscribers/{id}/bounces
retrieves a subscriber's bounce records
getSubscriberBouncesById 1 param → 200
DELETE
/subscribers/{id}/bounces
deletes a subscriber's bounce records
deleteSubscriberBouncesById 1 param → 200
POST
/subscribers/{id}/optin
sends an optin confirmation e-mail to a subscriber.
subscriberSendOptinById 1 param → 200
POST
/subscribers/query/delete
bulk deletes based on an arbitrary SQL expression.
deleteSubscriberByQuery body → 200
PUT
/subscribers/query/blocklist
bulk blocklists subscribers based on an arbitrary SQL expression.
blocklistSubscribersQuery body → 200
PUT
/subscribers/query/lists
bulk adds/removes/unsubscribes subscribers from one or more lists based on an arbitrary SQL expression.
manageSubscriberListsByQuery body → 200
GET
/subscribers/{subscriber_id}
Retrieve a specific subscriber.
getSubscriber 1 param → 200
PUT
/subscribers/{subscriber_id}
Update a specific subscriber.
updateSubscriber 1 param body → 200
DELETE
/subscribers/{subscriber_id}
Delete a specific subscriber.
deleteSubscriber 1 param → 200
POST
/subscribers/{subscriber_id}/optin
Send an opt-in confirmation email to a subscriber.
sendSubscriberOptin 1 param → 200
GET
/subscribers/{subscriber_id}/export
Export a subscriber's data.
exportSubscriber 1 param → 200
PUT
/subscribers/{subscriber_id}/blocklist
Blocklist a single subscriber.
blocklistSubscriber 1 param → 200

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Subscriber_2 (9 properties), Subscriber (9 properties), SubscriberProfile (8 properties), NewSubscriber (7 properties). Each schema is shown below with its type and property counts.

Subscriptions
object
4 properties
NewSubscriber
object
7 properties
Bounce
object
1 property
SubscriberQueryRequest
object
5 properties
SubscriberData
object
5 properties
Subscriber
object
9 properties
UpdateSubscriber
object
7 properties
SubscriberProfile
object
8 properties
SubscribersResponse
object
1 property
SubscriberResponse
object
1 property
SubscriberRequest
object
6 properties 1 required
SubscriberListsRequest
object
5 properties
Subscriber_2
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

listmonk-subscribers-api-openapi.yml Raw ↑

Other APIs listmonk publishes across the network.

listmonk Bounces API
listmonk Campaigns API
listmonk Import API
listmonk Lists API
listmonk Media API
listmonk Templates API
listmonk Transactional API
listmonk Admin API
listmonk Logs API
listmonk Maintenance API
listmonk Miscellaneous API
listmonk Public API
Where this information came from

This is an independent, third-party profile of listmonk Subscribers API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.