Vai al contenuto

Query batch recipients (HTTP QUERY method)

Richiesta

Lists the recipients of a batch, with cursor pagination.

This endpoint uses the HTTP QUERY method, not GET. OpenAPI cannot express the QUERY method, so it is shown here as a GET with the filter fields as query parameters. In practice, send an HTTP QUERY request with the fields (Cursor, Limit, SortDirection) in a JSON body.

Sicurezza
basicAuth
Percorso
BatchIdstring, (uuid)obbligatorio
Query
Cursorstring

Opaque pagination cursor returned by the previous response.

Limitinteger, [ 1 .. 1000 ]

Maximum number of recipients to return (1–1000).

SortDirectionstring
Enum:"None""Ascending""Descending"
curl -i -X GET \
  -u '<username>:<password>' \
  'https://api.evicertia.com/v2/EviNotice/Batches/{BatchId}/Recipients?Cursor=string&Limit=1&SortDirection=None'

Risposte

Query executed successfully.

Corpoapplication/json
Cursorstring

Opaque cursor for the next page of recipients.

ResultsArray of objects(EviNoticeBatchRecipient)
Risposta
{ "Cursor": "string", "Results": [ { … } ] }