Retrieve Email Notification Histories

Retrieve details about the email notifications sent by Vault. Details include the notification date, recipient, subject, and delivery status. In the UI, this information is available in Admin > Operations > Email Notification Status. Learn more about Email Notification Status in Vault Help.

GET/api/{version}/notifications/histories

Headers

Name	Description
`Content-Type`	`application/json` (default)
`Accept`	`application/json` (default) or `application/xml`

Query Parameters

You can modify the request by using one or more of the following parameters:

Request : 30 Days

curl -X GET -H "Authorization: {SESSION_ID}" \
https://myvault.veevavault.com/api/v23.1/notifications/histories?start_date=2022-09-10&end_date=2022-10-09

Response : 30 Days

{
   "responseStatus": "SUCCESS",
   "responseDetails": {
       "offset": 0,
       "limit": 200,
       "size": 3,
       "total": 3
   },
   "data": [
       {
           "send_date": "2022-09-13T06:44:18.000Z",
           "recipient_name": "Teresa Ibanez",
           "recipient_id": 995595,
           "recipient_email": "tibanez@veepharm.com",
           "status": "delivered__sys",
           "error_message": null,
           "subject": "Notification: Review completed, changes not required",
           "workflow_id": 1502,
           "task_id": null,
           "document_id": null,
           "major_version": null,
           "minor_version": null,
           "object_name": "envelope__sys",
           "object_record_id": "0ER00000000E002",
           "sender_name": "Justine Lo",
           "sender_id": 694695,
           "notification_id": 107,
           "included_notification_ids": null,
           "status_date": "2022-09-13T06:44:18.000Z",
           "template_name": "basereviewedapproved__v"
       },
       {
           "send_date": "2022-09-13T06:41:02.000Z",
           "recipient_name": "Teresa Ibanez",
           "recipient_id": 995595,
           "recipient_email": "tibanez@veepharm.com",
           "status": "delivered__sys",
           "error_message": null,
           "subject": "Notification: Documents not approved, changes required",
           "workflow_id": 1501,
           "task_id": null,
           "document_id": null,
           "major_version": null,
           "minor_version": null,
           "object_name": "envelope__sys",
           "object_record_id": "0ER00000000E001",
           "sender_name": "Megan Murray",
           "sender_id": 1083287,
           "notification_id": 106,
           "included_notification_ids": null,
           "status_date": "2022-09-13T06:41:03.000Z",
           "template_name": "baseapprovedwithchangesmdw__v"
       },
       {
           "send_date": "2022-09-13T06:37:18.000Z",
           "recipient_name": "Teresa Ibanez",
           "recipient_id": 1083287,
           "recipient_email": "tibanez@veepharm.com",
           "status": "delivered__sys",
           "error_message": null,
           "subject": "Notification: Mentioned in comment on sample.",
           "workflow_id": null,
           "task_id": null,
           "document_id": 6,
           "major_version": 0,
           "minor_version": 1,
           "object_name": null,
           "object_record_id": null,
           "sender_name": "Olivia Cattington",
           "sender_id": 995595,
           "notification_id": 104,
           "included_notification_ids": null,
           "status_date": "2022-09-13T06:37:18.000Z",
           "template_name": "usermentionnotifications__v"
       }
    ]
}

Request : All Dates

curl -X GET -H "Authorization: {SESSION_ID}" \
https://myvault.veevavault.com/api/v23.1/notifications/histories?all_dates=true&format_result=csv

Response : All Dates

{
   "responseStatus": "SUCCESS",
   "jobId": "639014",
   "url": "/api/v23.1/services/jobs/639014"
}