Skip to main content

List Mail Items

GET 

/subscription/:external_id/mail

Retrieves the mail items associated with the specified subscription, newest first. The response is paginated: use the page and page_size query parameters to move through the results, or follow the next and previous links. See Paging for details.

The ai_metadata object will only be populated with data if our Partner arrangement includes it. If not, its text fields are empty strings and its list fields are empty lists. ai_metadata is null when the item has no metadata.

The url, url_envelope_front and url_envelope_back fields are signed links that expire 24 hours after the request. Request the list again to get fresh links. Each is null when that scan does not exist.

Mail items can only be actioned, for example forwarded, within 30 days of being received.

Request​

Responses​

OK