Skip to main content

List sent emails of all reports

GET https://api.rollstack.com/public/v1/emails

The emails every report the user can see sent, of any type, newest first, each with its report, as the app's Email sends page lists them: pass status failed and since to find the ones that didn't go out, and burstId for one burst's. Same fields as listReportEmails. Answers up to limit emails, 20 by default and 200 at most, and a nextCursor: pass it as cursor for the next page, until it is null.

Requires the slide_decks:read scope.

Operation ID: listEmails.

Query parameters

  • limit (integer): Maximum number of emails to return on this page, from 1 to 200. Defaults to 20.
  • cursor (string): Where to continue the list: pass the nextCursor returned with the previous page to get the next one. Omit it for the first page. Example: 6c1f9a2e-3b4d-4e8f-9a1b-2c3d4e5f6a7b.
  • status (string): Only the emails in this state, as the Email sends page filters them: failed the ones that could not be sent, opened the ones a recipient opened, and delivered the ones the email server accepted, opened or not. If omitted, every email. One of delivered, failed, opened.
  • since (string (date-time)): Only what happened at or after this time, as an ISO 8601 date and time in UTC, such as 2026-11-08T18:00:00Z. If omitted, from the start. Example: 2026-11-08T18:00:00Z.
  • burstId (string): Only the emails of this burst, by its id from listBursts: each variant's own emails, and the emails its email configurations sent, which list its template as their report. If omitted, every report's.

Response 200

Success

application/json

  • data (array of object, required): The emails every report you can see sent, of any type, newest first, with what the Email sends page hides from you left empty. To find the emails that failed, pass status failed and since.
    • id (string, required): Identifies the sent email.
    • sentAt (string (date-time), required): When it was sent.
    • status (string, required): delivered when the email server accepted it, failed when it could not be sent (error says why), and opened once a recipient opened it, which Rollstack sees only when the organization has email analytics on. One of delivered, failed, opened.
    • trigger (string or null, required): scheduled when a scheduled run of the report sent it; manual when someone sent it, in the app or with sendReportEmail. null when it was not recorded. One of manual, scheduled.
    • sender (object, required): The member it was sent as: who sent it, or whose run sent it.
      • name (string or null, required)
      • email (string, required)
    • subject (string or null, required): The email's subject. null unless you own the report or it is shared with you directly, as on the Email sends page.
    • to (array of string, required): The addresses it was sent to. Empty unless you own the report, it is shared with you directly, or you are an owner or admin of the organization.
    • cc (array of string, required): The addresses copied on it, under the same rule as to.
    • bcc (array of string, required): The addresses it was blind-copied to, under the same rule as to.
    • error (string or null, required): Why it could not be sent, when it failed. null otherwise, or when you may not see its subject.
    • report (object, required): The report that sent it.
      • id (string, required): The report's id, to pass to the /reports/{id} endpoints, such as getReport.
      • name (string or null, required): The report's name.
  • nextCursor (string or null, required): Pass it as cursor to get the next page of emails. null when there are no more.