Emails
Retrieve an email
Changed onRetrieve the details of an email.
get/api/v1/emails/{email_id}
Request
- Base URLhttps://api1.unipile.com:13111
- AuthAPI key in header X-API-KEY
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
email_idstring required
The id of the email to be retrieved. Either the Unipile id or the provider uid.
Query parameters
account_idstring
The id of the account related to the email. Required when using the provider uid.
include_headersboolean
Include the email headers in the response.
Response
OK
Example response
{
"date": "2025-12-31T23:59:59.999Z",
"read_date": "2025-12-31T23:59:59.999Z"
}Changes
- warning
added the new
errors/password_reset_requiredenum value to theresponse property for the response status
- warning