Get all Emails
GET {{url}}/{{tenantName}}/{{instanceName}}/patients/:patientId/emails
Following Query Parameters can be used to sort or find approporiately
We can use any combination of this parameters in single request: Example: {{url}}/{{tenantName}}/{{instanceName}}/patients/{{patientId}}/emails?status=DELIVERED,FAILED&email=some-email@email.com&starred=true
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
receiver | string | When specified, search by receiver id | |
direction | string | When specified, search by direction (IN or OUT) | |
page | number | When specified, page number | |
size | number | When specified, size per page | |
starred | boolean | When specified, search by starred (boolean value) field (as an important email) | |
externalId | string | ||
email | string | When specified, search by 'to' or 'from' email | |
fromDate | string | ||
toDate | string | ||
sort | null | Allows one to specify the sort order of the returned emails collection | |
search | null | When specified, will execute a search based on subject and body fields | |
sender | null | When specified, search by sender id | |
from | null | When specified, search by 'from' email | |
to | null | When specified, search by 'to' email | |
senderName | null | When specified, search by sender name | |
receiverName | null | When specified, search by receiver name | |
status | null | When specified, search by status [SCHEDULED, ACCEPTED, DELIVERED, REJECTED, FAILED, UNRECOGNISED] |