Notification search

Return a list of notifications for the specified criteria

Request

Security:

vc-security

Request Body schema: application/json

orgId	string
orgPaths	Array of strings
sender	string
	object (UserKey)
type	string (Type) The type of the notification Enum: "EMAIL" "SMS" "PHONE" "WEB"
status	string (Status) The status of the notification Enum: "CREATED" "QUEUED" "SENT" "DELIVERED" "READ" "ERRORED" "DIGESTED" "PROCESSED" "DROPPED" "DEFERRED" "BOUNCED" "ACCEPTED" "SCHEDULED" "SENDING" "UNDELIVERED" "FAILED" "CANCELED"
messageId	string
eventKey	string
startTimestamp	string <date-time>
endTimestamp	string <date-time>

Responses

200

List of Notifications

401

Unauthorized request

post/notification-service/v1/notifications/search

Request samples

Payload
curl
Python
Node.js

application/json

{"orgId": "string",
"orgPaths": ["string"
],
"sender": "string",
"recipient": {"username": "string",
"authenticator": "string"
},
"type": "EMAIL",
"status": "CREATED",
"messageId": "string",
"eventKey": "string",
"startTimestamp": "2019-08-24T14:15:22Z",
"endTimestamp": "2019-08-24T14:15:22Z"
}

Response samples

application/json

[{"id": "string",
"sender": "string",
"recipients": [{"username": "string",
"authenticator": "string"
}
],
"rawRecipient": "string",
"type": "EMAIL",
"eventKey": "string",
"productName": "string",
"tags": ["string"
],
"language": "string",
"summary": "string",
"details": "string",
"shortSubject": "string",
"shortDescription": "string",
"templateNameKey": "string",
"dataModel": {"property1": "string",
"property2": "string"
},
"status": "CREATED",
"messageId": "string",
"responseCode": 0,
"responseMsg": "string",
"userOrgId": "string",
"emailForPreference": "string",
"attachmentContent": "string",
"attachmentMimeType": "string",
"attachmentFilename": "string",
"createdBy": "string",
"createdInstant": "2019-08-24T14:15:22Z",
"lastUpdatedBy": "string",
"lastUpdatedInstant": "2019-08-24T14:15:22Z"
}
]