Reference
Newsletter API
Endpoints under /api/newsletter, from the com_newsletter API controllers. Authenticate with an OAuth bearer token or a session cookie; see the developers book for the API basics.
| Method | Endpoint | Purpose |
|---|---|---|
GET |
/newsletters/archive |
Return data for past newsletters |
GET |
/newsletters/current |
Return data for the current newsletter |
GET |
/newsletters/list |
Return data for newsletters |
GET /newsletters/archive
Return data for past newsletters
API version 1.0, task archive in newslettersv1_0.php.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit |
integer | no | 5 | Number of result to return. |
start |
integer | no | 0 | Number of where to start returning results. |
GET /newsletters/current
Return data for the current newsletter
API version 1.0, task current in newslettersv1_0.php.
GET /newsletters/list
Return data for newsletters
API version 1.0, task list in newslettersv1_0.php.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit |
integer | no | 5 | Number of result to return. |
start |
integer | no | 0 | Number of where to start returning results. |
Generated from the source tree.