Skip to content

Query certified postal communications (GET)

Request

Security
basicAuth
Query
WithUniqueIdsstring

Filter by one or more unique IDs (comma-separated).

WithLookupKeysstring

Filter by one or more lookup keys (comma-separated).

OnStatestring

Filter by current state. Contact support before using this parameter.

Enum:"Draft""Submitted""Processed""Sent""Dispatched""Delivered""Missing""Closed""Issued""Failed"
WithOutcomestring

Filter by outcome. Contact support before using this parameter.

Enum:"None""Delivered""Dispatched""Acknowledged""Declined""Hindered""Cancelled""Expired""Failed""Sent"
OrderResultsBystring

Sort field for results.

Value:"CreationDate"
Offsetinteger

Number of results to skip for pagination.

Limitinteger, [ 1 .. 100 ]

Default and maximum are 100 without affidavits, 25 with affidavit metadata, and 1 with embedded affidavit PDFs.

IncludeDocumentOnResultboolean

Include the base64-encoded original document in results.

IncludeAffidavitsOnResultboolean

Include affidavit metadata in results.

IncludeAffidavitBlobsOnResultbooleandeprecated

When enabled with IncludeAffidavitsOnResult, embeds Base64 affidavit PDFs in affidavits[].bytes. Some deployments enable blobs when this flag is omitted. Set false explicitly for metadata-only results and use /AffidavitsDownload to fetch PDFs.

curl -i -X GET \
  -u '<username>:<password>' \
  'https://api.evicertia.com/v1/EviPost/Query?WithUniqueIds=string&WithLookupKeys=string&OnState=Draft&WithOutcome=None&OrderResultsBy=CreationDate&Offset=0&Limit=1&IncludeDocumentOnResult=true&IncludeAffidavitsOnResult=true&IncludeAffidavitBlobsOnResult=true'

Responses

Query executed successfully

Bodyapplication/json
totalMatchesinteger

Total number of records matching the query filters.

resultsArray of objects(EviPostQueryResult)
Response
{ "results": [ { … } ], "totalMatches": 1 }