How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kiteworks

Kiteworks Mail API

The mail API from Kiteworks — 29 operation(s) for mail.

Documentation Provider Profile APIs.io OpenAPI GitHub

Kiteworks Mail API is one of 41 APIs that Kiteworks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Mail. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 32 operations across 29 paths, and defines 39 schemas. It is described by OpenAPI 3.2.0, at version 28.

Requests are made against the base URL https://your.kiteworks.domain/rest.

32 operations 29 paths 39 schemas 4 DELETE16 GET5 PATCH5 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
28
Base URL
https://your.kiteworks.domain/rest
Resource Areas
1

Paths & Operations 32

Across 29 paths, the API surfaces 32 operations — 4 DELETE, 16 GET, 5 PATCH, 5 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Mail 32
GET
/rest/mail
Get messages in mail folders
getRestMail 35 params → 200490
DELETE
/rest/mail
Delete draft messages
deleteRestMail 2 params → 204207401403490
GET
/rest/mail/actions/counters
Get message counts for mail folders
getRestMailActionsCounters 1 param → 200401490
PATCH
/rest/mail/actions/deletePermanent
Permanently delete messages
patchRestMailActionsDeletePermanent 2 params → 200207401403410490
GET
/rest/mail/actions/distributionList
Expand a distribution list
getRestMailActionsDistributionList 3 params → 200403490
PATCH
/rest/mail/actions/read
Mark messages as read
patchRestMailActionsRead 2 params → 200207401403490
PATCH
/rest/mail/actions/recover
Recover deleted messages
patchRestMailActionsRecover 2 params → 200207401403410490
POST
/rest/mail/actions/sendFile
Send files
postRestMailActionsSendFile 3 params body → 201401403422490
PATCH
/rest/mail/actions/trash
Move messages to Trash
patchRestMailActionsTrash 2 params → 200207401403490
PATCH
/rest/mail/actions/unread
Mark messages as unread
patchRestMailActionsUnread 2 params → 200207401403490
GET
/rest/mail/{emailId}/attachments/actions/zip
Download email attachments in ZIP format
getRestMailByEmailIdAttachmentsActionsZip 7 params → 200403490
GET
/rest/mail/{emailId}/attachments/actions/zipStatus
Get email attachment security status
getRestMailByEmailIdAttachmentsActionsZipStatus 4 params → 200403490
GET
/rest/mail/{emailId}/attachments/report
Get email attachment download report
getRestMailByEmailIdAttachmentsReport 1 param → 200403490
GET
/rest/mail/{emailId}/attachments/reportCsv
Export email attachment download report as CSV
getRestMailByEmailIdAttachmentsReportCsv 1 param → 200403490
GET
/rest/mail/{emailId}/attachments/{id}/content
Download email attachment
getRestMailByEmailIdAttachmentsByIdContent 5 params → 200403490
GET
/rest/mail/{emailId}/attachments/{id}/preview
Get email attachment preview metadata
getRestMailByEmailIdAttachmentsByIdPreview 4 params → 200403490
GET
/rest/mail/{id}
Get email metadata
getRestMailById 6 params → 200490
DELETE
/rest/mail/{id}
Delete a draft message
deleteRestMailById 1 param → 204401403490
PUT
/rest/mail/{id}/actions/sendFile
Update and send a draft message
putRestMailByIdActionsSendFile 4 params body → 200401403422490
GET
/rest/mail/{id}/attachments
Get attachments for an email message
getRestMailByIdAttachments 4 params → 200401403490
GET
/rest/mail/{id}/attachments/{attachment_id}
Get an email attachment by attachment ID
getRestMailByIdAttachmentsByAttachmentId 3 params → 200401403490
GET
/rest/mail/{id}/packages
Get the package associated with an email
getRestMailByIdPackages 2 params → 200401403490
GET
/rest/mail/{id}/recipients
Get email recipients
getRestMailByIdRecipients 9 params → 200401403490
POST
/rest/mail/{id}/actions/withdrawFiles
Withdraw files from a sent message
postRestMailByIdActionsWithdrawFiles 3 params → 204401403422490
POST
/rest/mail/{id}/actions/copy
Save email attachments to a Kiteworks folder
postRestMailByIdActionsCopy 5 params body → 201401403422490
POST
/rest/mail/{id}/actions/sendTrackingReport
Send tracked activity report for a sent message
postRestMailByIdActionsSendTrackingReport 4 params → 201401403490
GET
/rest/mail/attachments
Get email attachments sent by the current user
getRestMailAttachments 4 params → 200401490
DELETE
/rest/mail/attachments
Withdraw multiple files from messages in Sent and Drafts folders
deleteRestMailAttachments 1 param → 204401422490
POST
/rest/mail/actions/withdraw
Withdraw messages from Sent and Drafts folders
postRestMailActionsWithdraw body → 200207401403490
GET
/rest/mail/{id}/scanStatus
Get email message security scan status
getRestMailByIdScanStatus 1 param → 200401403490
DELETE
/rest/mail/{id}/trackings/me
Remove message tracking access
deleteRestMailByIdTrackingsMe 1 param → 200401403490
PUT
/rest/mail/{id}/settings
Update message tracking access
putRestMailByIdSettings 1 param body → 200401403490

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are File (46 properties), Mail (45 properties), Mail1 (44 properties), Folder (43 properties). Each schema is shown below with its type and property counts.

UserBasic
object
4 properties
Member
object
14 properties
BulkOperationInteger
object
2 properties
Error
object
2 properties
DrmFile
object
2 properties
Package
object
9 properties
Recipient
object
5 properties
SendMailSettingPutRequest
object
1 property
Mails
object
2 properties
Permission
object
3 properties
Folder
object
43 properties
MobileInfo
object
5 properties
Attachment
object
19 properties
EmailReturnRecipient
object
2 properties
SafeEdit
object
2 properties
Preview
object
Class Preview
10 properties
MetaData
object
3 properties
Mail1
object
44 properties
MailCounters
object
9 properties
BaseSendMailPostRequest
object
24 properties
Mail
object
45 properties
MailAttachments
object
2 properties
Tag
object
3 properties
TrackingAccessRecipient
object
6 properties
Fingerprint
object
2 properties
Role
object
4 properties
UserAttachment
object
10 properties
File
object
46 properties
AttachmentDownloadReport
object
Represents the download tracking report for the attachments of a specific email.
3 properties
AttachmentDownloadEvent
object
Represents a single download or interaction event recorded for an email attachment.
8 properties
ErrorInteger
object
4 properties
MailWithdrawRequest
object
1 property 1 required
Variables
object
2 properties
Attachments
object
2 properties
PushedObject
object
4 properties
DestinationFolderIdRequest
object
2 properties 1 required
Group
object
5 properties
Errors
object
1 property
DistributionList
object
Class DistributionList
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kiteworks-mail-api-openapi.yml Raw ↑

Other APIs Kiteworks publishes across the network.

Kiteworks Activities API
AE Profile APIs.io
Kiteworks Admin API
AE Profile APIs.io
Kiteworks Advanced Forms API
AE Profile APIs.io
Kiteworks Cards API
AE Profile APIs.io
Kiteworks Client Event Logs API
AE Profile APIs.io
Kiteworks Clients API
AE Profile APIs.io
Kiteworks Comments API
AE Profile APIs.io
Kiteworks Contacts API
AE Profile APIs.io
Kiteworks Devices API
AE Profile APIs.io
Kiteworks Dli API
AE Profile APIs.io
Kiteworks External DL API
AE Profile APIs.io
Kiteworks Favorites API
AE Profile APIs.io
#Mail
← Back to K APIs
API Details
ID
kiteworks:kiteworks-mail-api
Base URL
https://your.kiteworks.domain/rest
Docs
https://developer.kiteworks.com/api-endpoints.html
Provider
Kiteworks
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=kiteworks-mail-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/kiteworks-mail-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Kiteworks Mail API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.