Get newsletter subscriber lists

Description

Returns all accepted newsletter subscriber lists for the associated community. Each item includes the list name, community id, status, optional timestamps, and a count of accepted subscribers assigned to that list (within the same community).

HTTP Method: GET

Endpoint: api/v1/global/newsletter/subscriberList

Request Details

Headers

Key	Type	Required	Description
x-api-key	string	Yes	API key provided by the Networked Team.

Query parameters

Parameter	Type	Required	Description
(none)	—	—	This endpoint does not accept query parameters.

Sample response

{
  "data": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "community": "507f191e810c19729de860ea",
      "name": "Weekly digest",
      "status": 1,
      "count": 128,
      "timeStamp": 1711800000000
    }
  ],
  "error": false,
  "message": "Operation completed successfully"
}

Response interface

Response field descriptions

Key	Type	Description
data	array	Subscriber list documents for the associated community.
data[].name	string	Display name of the list.
data[].community	string	Community ObjectId the list belongs to.
data[].count	number	Number of accepted subscribers on this list in this community.
data[].status	number	List status (`ModelStatus`); accepted lists are returned.
data[].timeStamp	number	Optional server timestamp.
error	boolean	`false` on success.
message	string	Outcome message.

Reference

🔗 Standard Response Codes

Notes

Use valid x-api-key scoped to your community.

{ "data": [ { "_id": "69ca46377851020013b82ab6", "status": 1, "name": "list1", "community": "69baa36beddb9f0012fdf0fa", "timeStamp": 1774863927338, "__v": 0, "count": 0 }, { "_id": "69ca46377851020013b82ab7", "status": 1, "name": "list2", "community": "69baa36beddb9f0012fdf0fa", "timeStamp": 1774863927338, "__v": 0, "count": 0 } ], "error": false, "message": "Operation completed successfully" }