# Query batch recipients (HTTP QUERY method)

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.

Endpoint: GET /v2/EviNotice/Batches/{BatchId}/Recipients
Version: 1.0
Security: basicAuth

## Path parameters:

  - `BatchId` (string, required)

## Query parameters:

  - `Cursor` (string)
    Opaque pagination cursor returned by the previous response.

  - `Limit` (integer)
    Maximum number of recipients to return (1–1000).

  - `SortDirection` (string)
    Enum: "None", "Ascending", "Descending"

## Response 200 fields (application/json):

  - `Cursor` (string)
    Opaque cursor for the next page of recipients.

  - `Results` (array)

  - `Results.LookupKey` (string)

  - `Results.DisplayName` (string)

  - `Results.LegalName` (string)

  - `Results.Address` (string)
    Recipient email address or mobile number.

  - `Results.ExtraFields` (object)
    Custom per-recipient fields supplied as *-prefixed CSV columns.

  - `Results.CustodyChallenge` (string)

  - `Results.CustodyChallengeResponse` (string)

  - `Results.DeliveryOtpChannel` (string)

  - `Results.DeliveryOtpAddress` (string)

  - `Results.EvidenceUniqueId` (string)
    ID of the generated EviNotice for this recipient, once the batch has been processed.

  - `Results.Channel` (string)

  - `Results.DeliveryChallenge` (string)

  - `Results.DeliveryChallengeResponse` (string)


## Response 400 fields

## Response 401 fields

## Response 404 fields