Passer au contenu

Query certified emails (GET)

Requête

Sécurité
basicAuth
Requête
WithUniqueIdsstring
WithLookupKeysstring
WithLinkedIdstring, (uuid)

Filters by linked ID, such as a batch ID. Cannot be combined with affidavit or attachment inclusion flags.

OnStatestring
Enum:"Draft""New""Ready""Sent""Dispatched""Delivered""Read""Replied""Closed""Failed"
WithOutcomestring
Enum:"None""Certified""Sent""Delivered""Read""Accepted""Rejected""Failed"
OrderResultsBystring
Value:"CreationDate"
Limitinteger, [ 0 .. 100 ]

Default and maximum of 100 for an ordinary query, 25 with affidavit or attachment metadata, or 1 with binary content.

Offsetinteger
IncludeAffidavitsboolean
IncludeAffidavitBlobsbooleanobsolète

Deprecated. When true with IncludeAffidavits, includes Base64 affidavit PDFs in affidavits[].bytes and limits the query to one email. Set false for metadata-only results and use /AffidavitsDownload for new integrations.

IncludeAttachmentsboolean
IncludeAttachmentBlobsbooleanobsolète

With IncludeAttachments, includes Base64 file contents in attachments[].data and limits the query to one email. Set false explicitly for metadata-only results and use /AttachmentDownload for new integrations.

curl -i -X GET \
  -u '<username>:<password>' \
  'https://api.evicertia.com/v1/EviMail/Query?WithUniqueIds=string&WithLookupKeys=string&WithLinkedId=497f6eca-6276-4993-bfeb-53cbbbba6f08&OnState=Draft&WithOutcome=None&OrderResultsBy=CreationDate&Limit=0&Offset=0&IncludeAffidavits=true&IncludeAffidavitBlobs=true&IncludeAttachments=true&IncludeAttachmentBlobs=true'

Réponses

Query executed successfully

Corpsapplication/json
totalMatchesinteger
resultsArray of objects(EviMailQueryResult)
Réponse
{ "totalMatches": 0, "results": [ { … } ] }