PHPackages                             albedo/module-newsletter-api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. albedo/module-newsletter-api

ActiveMagento2-module[API Development](/categories/api)

albedo/module-newsletter-api
============================

REST API Layer for Magento Newsletter module.

1.0.0(5y ago)727.7k↓15.4%6[1 issues](https://github.com/adamkarnowka/magento2-newsletter-api/issues)OSL-3.0PHP

Since Dec 28Pushed 5y ago1 watchersCompare

[ Source](https://github.com/adamkarnowka/magento2-newsletter-api)[ Packagist](https://packagist.org/packages/albedo/module-newsletter-api)[ RSS](/packages/albedo-module-newsletter-api/feed)WikiDiscussions master Synced 2d ago

READMEChangelog (1)DependenciesVersions (2)Used By (0)

Magento2 API Endpoint for Newsletter module
===========================================

[](#magento2-api-endpoint-for-newsletter-module)

```
albedo/module-newsletter-api

```

### Description

[](#description)

REST API Layer for Magento Newsletter module adds additional 4 methods which allow to list and manage Magento subscribers.

Somehow, Magento Newsletter doesn't provide these methods out of the box, while they might be useful for 3rd party integrations with ESPs or other marketing software.

Read more on:

*Features:*

- Possibility to get list using `searchCriteria`
- Possiblity to subscribe/confiirm/unsubscribe using REST
- Separate ACL rules for read/write permissions

When e-mail is subscribed, it will trigger/dispatch all observers and send e-mail to customer. It is equivalent to subscribe with normal form (same Magento methods used).

📖 API Reference (Postman):

You can run tests by executing:

```
php ../../../vendor/bin/phpunit ../../../app/code/Albedo/NewsletterApi/Test/* -c ../api-functional/phpunit_rest.xml

```

⚠️ Make sure to have `api-functional/phpunit_rest.xml` properly configured!

*Roadmap*:

- possibility to send multiple contacts in one requests
- deleting subscribers

### Installation

[](#installation)

Install the module composer by running

`composer require albedo/module-newsletter-api`

Enable the module by running

`php bin/magento module:enable Albedo_NewsletterApi`

Apply database updates by running

`php bin/magento setup:upgrade`

Flush the cache by running

`php bin/magento cache:flush`

###  Health Score

32

—

LowBetter than 69% of packages

Maintenance17

Infrequent updates — may be unmaintained

Popularity36

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity53

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

2014d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/511845?v=4)[Adam Karnowka](/maintainers/adamkarnowka)[@adamkarnowka](https://github.com/adamkarnowka)

---

Top Contributors

[![adamkarnowka](https://avatars.githubusercontent.com/u/511845?v=4)](https://github.com/adamkarnowka "adamkarnowka (9 commits)")

---

Tags

apimagento2magento2-free-extensionmagento2-modulenewsletter

### Embed Badge

![Health badge](/badges/albedo-module-newsletter-api/health.svg)

```
[![Health](https://phpackages.com/badges/albedo-module-newsletter-api/health.svg)](https://phpackages.com/packages/albedo-module-newsletter-api)
```

###  Alternatives

[exsyst/swagger

A php library to manipulate Swagger specifications

35916.4M7](/packages/exsyst-swagger)[hubspot/api-client

Hubspot API client

24016.2M20](/packages/hubspot-api-client)[pocketmine/bedrock-protocol

An implementation of the Minecraft: Bedrock Edition protocol in PHP

172445.0k15](/packages/pocketmine-bedrock-protocol)[botman/driver-telegram

Telegram driver for BotMan

93459.5k6](/packages/botman-driver-telegram)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)