Get newsletter subscribers

Description

Returns a paginated list of newsletter subscribers for the associated community . Each row can include linked user profile data, profile image URL, community privilege, and resolved subscriber-list metadata when lists exist.

HTTP Method: GET

Endpoint: api/v1/global/newsletter/subscriber

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
`start`	number	Yes	Pagination start index .
`count`	number	Yes	Page size .
`status`	number	No	Filter by subscriber status (`ModelStatus`). Examples: `1` Accepted, `60` Unsubscribe, `30` Deleted.
`keyword`	string	No	Regex match on `email` or `name` (case-insensitive).
`withList`	boolean / string	No	If `true`, only subscribers with a non-empty `subscriberList`.
`noList`	boolean / string	No	If `true`, only subscribers with no lists.
`listId`	string (repeatable)	No	Subscriber list ObjectId; subscriber must include that list. Use multiple `listId` keys for several lists.

Note: Do not combine withList, noList, and listId filters in conflicting ways; the handler applies branches in order (withList → noList → listId).

Sample response

{
  "data": {
    "customListWithTags": [
      {
        "_id": "67a1b2c3d4e5f6789012345a",
        "email": "reader@example.com",
        "name": "Reader Name",
        "status": 1,
        "community": "67959032bc6bea0012fdc670",
        "subscriberList": ["64b2c3d4e5f6789012345ab"],
        "subscriberLists": [{ "_id": "64b2c3d4e5f6789012345ab", "name": "Weekly digest" }],
        "user": { "_id": "...", "status": 1, "name": "...", "image": "..." },
        "userImage": { "url": "https://..." },
        "communityPrivilege": { "_id": "...", "status": 1 }
      }
    ],
    "totalCount": 42,
    "count": 30,
    "nextStart": true
  },
  "error": false,
  "message": "Operation completed successfully"
}

Response interface

Response field descriptions

Key	Type	Description
data.customListWithTags	array	Subscriber documents with lookups (user, image, lists, privilege).
data.totalCount	number	Total matching subscribers (all pages).
data.count	number	Requested page size (`count` query).
data.nextStart	boolean	`true` if more pages exist after this window.
error	boolean	`false` on success.
message	string	Outcome message.

Reference

🔗 Standard Response Codes

Notes

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

Pagination: increase start by count while nextStart is true.

{ "data": { "customListWithTags": [ { "_id": "69ca3eedf9c0164ef42005f1", "subscriberList": [ "69ca46377851020013b82ab6" ], "status": 1, "email": "subscriber1@yopmail.com", "community": "69baa36beddb9f0012fdf0fa", "subscriberLists": [ { "_id": "69ca46377851020013b82ab6", "status": 1, "name": "list1", "community": "69baa36beddb9f0012fdf0fa", "timeStamp": 1774863927338, "__v": 0 } ] }, { "_id": "69ca3eedf9c0164ef42005f2", "subscriberList": [], "status": 1, "email": "subscriber2@yopmail.com", "community": "69baa36beddb9f0012fdf0fa", "subscriberLists": [] }, { "_id": "69cb70a7818d4600124c213f", "subscriberList": [], "status": 1, "email": "subscriber23@yopmail.com", "community": "69baa36beddb9f0012fdf0fa", "subscriberLists": [] } ], "totalCount": 3, "count": 30, "nextStart": false }, "error": false, "message": "Operation completed successfully" }