Sign in

v1

latestOpenAPI 3.0.02026-07-24276673.3 KB
Mail Items

Retrieve a mail item

Returns a single mail item.

get/v1/mail-items/{id}

Path parameters

idstring required

Headers

x-api-keystring required

Response

Success

idstring required
fromstring required
archivedAtstring
readAtstring
barcodeIdstring
businessRecipientstring

@deprecated Use the recipients field to get the recipient information

individualRecipientstring

@deprecated Use the recipients field to get the recipient information

clearAtstring required
imageUrlstring required
ocrResultUrlsstring[]
isReturnedToSenderboolean

True if the mail item appears to be returned to sender.