PHPackages phplist/rest-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. [HTTP & Networking](/categories/http) 4. / 5. phplist/rest-api ActivePhplist-module[HTTP & Networking](/categories/http) phplist/rest-api ================ A REST API for phpList, the world's most popular open source newsletter manager v5.0.0-alpha8(10mo ago)242.8k14[1 issues](https://github.com/phpList/rest-api/issues)[1 PRs](https://github.com/phpList/rest-api/pulls)1AGPL-3.0-or-laterPHPPHP ^8.1CI passing Since Jan 31Pushed 1mo ago7 watchersCompare [ Source](https://github.com/phpList/rest-api)[ Packagist](https://packagist.org/packages/phplist/rest-api)[ Docs](https://www.phplist.com/)[ RSS](/packages/phplist-rest-api/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (2)Dependencies (13)Versions (11)Used By (1) phpList 4 REST API ================== [](#phplist-4-rest-api) [![Build Status](https://github.com/phpList/rest-api/workflows/phpList%20REST%20API%20Build/badge.svg)](https://github.com/phpList/rest-api/actions)[![Latest Stable Version](https://camo.githubusercontent.com/e3020b681373377025dccaee5c5d3128e624e2c1ee9d0ce2969a7f888db39742/68747470733a2f2f706f7365722e707567782e6f72672f7068706c6973742f726573742d6170692f762f737461626c652e737667)](https://packagist.org/packages/phpList/rest-api)[![Total Downloads](https://camo.githubusercontent.com/80338a0391d9f05db23b08a6c46b71906a97a84aeb4f8adfca4e08becf0e922b/68747470733a2f2f706f7365722e707567782e6f72672f7068706c6973742f726573742d6170692f646f776e6c6f6164732e737667)](https://packagist.org/packages/phpList/rest-api)[![Latest Unstable Version](https://camo.githubusercontent.com/ef29054cf725568021e38f63390fba901333c437ed30ba60a33d72880edd383f/68747470733a2f2f706f7365722e707567782e6f72672f7068706c6973742f726573742d6170692f762f756e737461626c652e737667)](https://packagist.org/packages/phpList/rest-api)[![License](https://camo.githubusercontent.com/f3efa42f6044fbadbc70c04257e96506b522a91c099046a49905a4d5bd783722/68747470733a2f2f706f7365722e707567782e6f72672f7068706c6973742f726573742d6170692f6c6963656e73652e737667)](https://packagist.org/packages/phpList/rest-api) About phpList ------------- [](#about-phplist) phpList is an open source newsletter manager. About this package ------------------ [](#about-this-package) This module is the REST API for phpList 4, providing functions for superusers to manage lists, subscribers and subscriptions via REST calls. It uses functionality from the `phplist/core` module (the phpList 4 core). It does not contain any SQL queries, uses functionality from the new core for DB access. This module is optional, i.e., it is possible to run phpList 4 without the REST API. This new REST API can also be used to provide REST access to an existing phpList 3 installation. For this, the phpList 3 installation and the phpList 4 installation with the REST API need to share the same database. For security reasons, the REST APIs from phpList 3 and phpList 4 should not be used for the same database in parallel, though. Installation ------------ [](#installation) Please install this package via Composer from within the [phpList base distribution](https://github.com/phpList/base-distribution), which also has more detailed installation instructions in the README. API Documentation ----------------- [](#api-documentation) Visit `https://phplist.github.io/restapi-docs/` endpoint to access the full interactive documentation for `phpList/rest-api`. Look at the **"API Documentation with Swagger"** section in the [contribution guide](.github/CONTRIBUTING.md) for more information on API documenation. Local demo with Postman ----------------------- [](#local-demo-with-postman) You can try out the API using pre-prepared requests and the Postman GUI tool. Install Postman as a browser extension or stand-alone app, open the [phpList 4 REST API Demo collection](https://documenter.getpostman.com/view/3293511/phplist-4-rest-api-demo/RVftkC9t#4710e871-973d-46fa-94b7-727fdc292cd5)and click "Run in Postman". Contributing to this package ---------------------------- [](#contributing-to-this-package) Please read the [contribution guide](.github/CONTRIBUTING.md) on how to contribute and how to run the unit tests and style checks locally. ### Code of Conduct [](#code-of-conduct) This project adheres to a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project and its community, you are expected to uphold this code. ### Health Score 51 — FairBetter than 96% of packages Maintenance73 Regular maintenance activity Popularity32 Limited adoption so far Community24 Small or concentrated contributor base Maturity64 Established project with proven stability Bus Factor1 Top contributor holds 67.6% 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 Every ~386 days Recently: every ~31 days Total 8 Last Release 321d ago Major Versions v4.0.0-alpha5 → v5.0.0-alpha12025-02-25 PHP version history (3 changes)v4.0.0-alpha1PHP ~7.0.0 || ~7.1.0 || ~7.2.0 v4.0.0-alpha5PHP ^7.2|^8.0 v5.0.0-alpha1PHP ^8.1 ### Community Maintainers ![](https://www.gravatar.com/avatar/037bbc2508491c234e383f06d7d9d2c498287038887ca7fc12c9750ab015e094?d=identicon)[samtuke](/maintainers/samtuke) ![](https://www.gravatar.com/avatar/0547fb66da95b0064d5586513a5b61a915330920cc8e3a13f30682bde22fc509?d=identicon)[phplist](/maintainers/phplist) --- Top Contributors [![oliverklee](https://avatars.githubusercontent.com/u/765746?v=4)](https://github.com/oliverklee "oliverklee (92 commits)")[![TatevikGr](https://avatars.githubusercontent.com/u/187495323?v=4)](https://github.com/TatevikGr "TatevikGr (19 commits)")[![tatevikg1](https://avatars.githubusercontent.com/u/61038422?v=4)](https://github.com/tatevikg1 "tatevikg1 (9 commits)")[![xh3n1](https://avatars.githubusercontent.com/u/9008509?v=4)](https://github.com/xh3n1 "xh3n1 (6 commits)")[![michield](https://avatars.githubusercontent.com/u/569843?v=4)](https://github.com/michield "michield (5 commits)")[![nfebe](https://avatars.githubusercontent.com/u/14317775?v=4)](https://github.com/nfebe "nfebe (4 commits)")[![schmidtsabine](https://avatars.githubusercontent.com/u/66960492?v=4)](https://github.com/schmidtsabine "schmidtsabine (1 commits)") --- Tags apirestemailmanagernewsletterphplist ### Code Quality TestsPHPUnit Static AnalysisPHPStan Code StylePHP\_CodeSniffer Type Coverage Yes ### Embed Badge ![Health badge](/badges/phplist-rest-api/health.svg) ``` [![Health](https://phpackages.com/badges/phplist-rest-api/health.svg)](https://phpackages.com/packages/phplist-rest-api) ``` ### Alternatives [nelmio/api-doc-bundle Generates documentation for your REST API from attributes 2.3k63.6M233](/packages/nelmio-api-doc-bundle)[daniel-zahariev/php-aws-ses Send emails via Amazon Simple Email Service (SES) with REST-like interface 3111.5M8](/packages/daniel-zahariev-php-aws-ses)[infobip/infobip-api-php-client PHP library for consuming Infobip's API 921.8M10](/packages/infobip-infobip-api-php-client)[abantecart/ups-php UPS PHP SDK based on OAuth 1815.3k](/packages/abantecart-ups-php) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)