Why is the API missing GetQuarantinedMessages

Problem reported by David Fisher - 5/27/2026 at 9:15 PM

Resolved

Hi,

I was playing around with the API some today, and it seems great you can use GetQuarantinedMessage to retrieve message data for specified quarantined messages from spam or virus quarantine.

However the API lacks one CRUCIAL ability. That is Get a list of items in the Spam and/or Virus Quarantine in the first place.

You cannot retrieve, more or delete a message in the Quarantine unless you know the exact filename and path (which spool it is in).

I cannot figure out a way to know this unless you log into the Web Interface.

Please add this as a feature request, if there is no ability to do this through the API.

4 Replies

Reply to Thread

Kyle Kerst Replied

5/28/2026 at 7:52 AM

Employee Post Marked As Resolution

I did some searching through our API documentation and believe this is achieved via the main endpoint for listing spool contents:

POST api/v1/settings/sysadmin/spool-messages

(Controller method: GetSpoolMessages, requires SysAdmin role)

This endpoint returns a paginated, searchable list of spool messages. To retrieve quarantined items specifically, you use the filter field in the request body (inside SpoolInput). The supported filter values are:

| Filter value | What it returns |

|---|---|

| "quarantine_spamout" | All messages in Spam Quarantine |

| "quarantine_virus" | All messages in Virus Quarantine |

| "waiting" | Messages waiting for remote delivery |

| "processing" | Messages currently being processed |

| (omit or empty) | All non-killed spool messages |

Kyle Kerst

Lead Internal Network/System Administrator

SmarterTools Inc.

smartertools.com

David Fisher Replied

5/28/2026 at 9:08 AM

Hi Kyle,

It worked! Thank You Very Much! AI & I went through the public Documentation for the API and saw nothing regarding the filter values. Were you looking in your internal documentation?

We were thinking it would be the GetSpoolMessages as it splits out virus_quarantine = 0 to us, so thinking there must be a way to get it to say 1 instead, and we had a feeling it would be the Filter, but trying a much of combinations for wording and case we didn't try the underscore instead of a space, oh and of course we didn't put the word quarantine before virus :)

If it is indeed on your public API Documentation, do you mind sharing where that is, so if I run into any future issues I will know where to look.

Thanks!

Kyle Kerst Replied

5/28/2026 at 9:32 AM

Employee Post

You're very welcome David, happy to help out! I found these calls here:

https://mail.smartertools.com/Documentation/api#/reference/SmarterMail.Web.Api.SystemAdminSettingsController/GetSpoolMessages/post

The filter types along with their formats are noted down below :) In this case the values passed just need to be a 1/0 to return only those messages. I believe we have plans to build out this documentation with more detailed examples in the future so I'll leave a note with our documentation team to touch on this one when they do.

Kyle Kerst

Lead Internal Network/System Administrator

SmarterTools Inc.

smartertools.com

David Fisher Replied

5/28/2026 at 10:45 AM

Hi Kyle,

I do thank you again, however I do not see what you are talking about on this page, I was on this page for hours trying to figure out how to do this. I even downloaded a PDF copy (Save as PDF) and gave it to AI and it couldn't find what you were referring to.

Is there a way to obtain the entire API Documentation via PDF, so I can print the entire Topics and API Reference?

Back to Community Threads

Please leave this box unchecked

Reply to Thread

Enter the verification text