Returns Newsletter_ID, and related information for all Newsletters.


JSON Request Example:    


/**
 * Users::GetNewsletters
 */
{
  "username": "bob",
  "usertoken": "123",
  "requesttype": "Users",
  "requestmethod": "GetNewsletters",
  "details": {
    "summary": "{*show_summary_only_boolean*}",
    "pagination": { /* optional: default return all at once */
      "limit": "{*max_records*}", /* required */
      "next": "{*start_at_record_number*}" /* optional: default 0 */
    }
  }
}
JavaScript

 "json_request"  element


Field NameDescription
usernameUsername used to login to Pinpointe
usertokenUnique token assigned to Pinpointe account
requesttypeUsers
requestmethodGetNewsletters
summaryBoolean (1/0; T/F)
Summary Only False: Returns only the Newsletter summary information; no HTML

Summary Only True: Returns the Newsletter summary and the Newsletter HTML
paginationOptional
limitMax Records per page
nextStarting record number for next page



Successful Response:


Field NameDescription
statusWill return SUCCESS if newsletters found for the user name supplied


Sample Successful Response

{
   status: "SUCCESS",
   data: {
      count: "476",
      pagecount: "100",
      newsletters: [
         {
            newsletterid: "12345",
            name: "Testing_Newsletter_1",
            format: "b",
            subject: "Testing Newsletter 1",
            createdate: "2018-11-05T18:18:01.000Z",
            active: "1",
            archive: "0",
            ownerid: "123",
            editor: "d",
            updatedate: "2024-06-19T16:44:12.000Z",
            approved: "1",
            rss: "1"
         },
...
         {
            newsletterid: "12445",
            name: "Testing_Newsletter_100",
            format: "b",
            subject: "Testing Newsletter 100",
            createdate: "2021-09-07T15:53:31.000Z",
            active: "1",
            archive: "0",
            ownerid: "946",
            editor: "d",
            updatedate: "2021-09-07T15:53:31.000Z",
            approved: "1",
            rss: "1"
         }
      ]
   },
   paging: {
      limit: "100",
      next: "100"
   },
   version: "4.0",
   elapsed: "0.023",
   timestamp: "2025-06-10T13:06:59.000Z"
}



Field NameDescription
countTotal count of newsletters
newsletteridNewsletter ID
formatWhat format is the Newsletter in? b (Multi-Part); t (Text); H (HTML)
subjectNewsletter Subject
createdateCrate date of the Newsletter
activeIs the newsletter active? Boolean (1/0; T/F)
archiveIs the newsletter active? Boolean (1/0; T/F)
owneridNewsletter Owner ID#
editorWhich editor was it made with? d (DND); w (WYSIWYG); b (Basic Editor)
updatedateNewsletter last edit date
approvedBoolean (1/0; T/F)
rssBoolean (1/0; T/F)


Unsuccessful Response:


"response" element


Field NameDescription
statusWill return FAILED when unsuccessful
errormessageText explaining why request failed