Chat now with support
Chat with Support

Archive Manager 5.9.6 - RESTful API Service Guide

Common rules Advanced searches Alert service global setting Alert service policies Alert service queries Attachments Authentication (login) Configurations Contacts Delegations Exported searches Folders Groups Logins Login domains Mailboxes Mailstores Messages
.../v1/messages/schema.{format} .../v1/messages.{format} .../v1/messages/{messageId}.{format} .../v1/messages/{messageId}/html.{format} .../v1/messages/{messageId}/plaintext.{format} .../v1/messages/{messageId}/raw.{format} .../v1/messages/{messageId}/rtf.{format} .../v1/messages/{checksum}/bodyhtml .../v1/messages/{checksum}/eml .../v1/messages/{checksum}/sendmail.{format} .../v1/messages/{checksum}/web.{format} .../v1/messages/searchresults/schema.{format} .../v1/messages/rtfImage/{fileName} .../v1/messages/web/schema.{format} .../v1/messages/web.{format} .../v1/messages/{checksumOrId}/accesshistories.{format} .../v1/messages/{checksumOrId}/availabletags.{format} .../v1/messages/{checksumOrId}/comments.{format} .../v1/messages/{checksumOrId}/journalreports.{format} .../v1/messages/{checksumOrId}/tags.{format} .../v1/messages/{checksumOrId}/tags/{tagId}.{format}
Message comments Message folders Message tags Message types Organizational units Product Retention change logs Retention holds Retention message logs Retention policies Retention runs Retention run policies Retention schedule Retention settings Security roles Server Tags

.../v1/attachments.{format}

GET

Supported HTTP method

GET

GET

Retrieves a list of attachments. If no query parameters are specified, the current login ID is applied.

Parameters:

Query parameters:

attachmentType: Separate multiple types by semicolon, for example, txt;pdf;docx. Use the symbol "!" to exclude a file type, for example, !txt;!pdf, this will search for messages that do not have TXT or PDF attachment(s).
attachmentAttachMethod: For example, attachmentType:Ole|EmbeddedMsg.
tagName: Separate multiple tags by semicolon, for example, tagName:Food;Fruit. Use the symbol "!" to exclude a tag, for example, tagName:!Food;!Fruit.

Sortable fields:

TIP: For example, to search all attachments,
.../v1/attachments.json?query=searchallemails:true

To search attachments by query ID,
...v1/attachments.json?=S0VZOkxPQ0FMOjE7YTYwYjkzM2M1NmE0MGQ0OGIwNGQzY2Y5MmUxMzA2OTF8MjAxNTA4MTQwNjAzMzFaXzE3ZQ==

To search attachments by Full Text Search,
.../v1/attachments.json?query=ftsQuery:Software,ftsScope:All

JSON response sample

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating