# List Batch Message Recipients

List Batch Message Recipients

Endpoint: GET /v1/batch_message/{id}/recipients
Version: 1.0.0
Security: apiKeyAuth, practiceGroupId

## Path parameters:

  - `id` (string, required)

## Query parameters:

  - `page_size` (integer)

  - `page_index` (integer)

  - `status` (string)
    Enum: "CREATED", "ENRICHMENT_ERROR", "ENRICHED", "INVALID_PAYLOAD", "QUEUED"

## Response 200 fields (application/json):

  - `data` (array, required)

  - `data.enrichment_status` (string, required)
    Enum: "CREATED", "ENRICHMENT_ERROR", "ENRICHED", "INVALID_PAYLOAD", "QUEUED"

  - `data.first_name` (string)

  - `data.last_name` (string)

  - `data.nhs_number` (string)

  - `data.mobile` (string)

  - `data.email` (string)

  - `count` (number, required)

## Response 400 fields (application/json):

  - `error` (boolean, required)

  - `statusCode` (number, required)

  - `message` (array, required)

  - `message.code` (string, required)

  - `message.expected` (string, required)

  - `message.path` (array, required)


## Response 401 fields

## Response 404 fields

## Response 500 fields