Skip to content

Retrieve an email metadata for given document ID

Request

Security
OAuth2(Required scopes: emails.read)
Path
idstring(Document identifier)required
Example:6295dcd39db1ab740c3e296c
curl -i -X GET \
  https://api.cloud.hypatos.ai/v2/emails/6295dcd39db1ab740c3e296c \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Bodyapplication/json
idstring(Document id)required
Example:"6040dc9680b782b365ea77d5"
senderAddressesArray of strings(Email sender adresses)required
Example:
[
  "no-replay@hypatos.com",
  "joe.doe@example.com"
]
subjectstring(Email subject)
Example:"Document from this month"
Response
{
  "id": "6040dc9680b782b365ea77d5",
  "senderAddresses": [
    "no-replay@hypatos.com",
    "joe.doe@example.com"
  ],
  "subject": "Document from this month"
}