# List Batch Messages

List Batch Messages

Endpoint: GET /v1/batch_message
Version: 1.0.0
Security: apiKeyAuth, practiceGroupId

## Query parameters:

  - `page_size` (integer)

  - `page_index` (integer)

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

## Response 200 fields (application/json):

  - `id` (string, required)

  - `name` (string, required)

  - `status` (string, required)
    Enum: "CREATED", "PENDING", "SENDING", "COMPLETED"

  - `channel` (string, required)
    Enum: "SMS", "EMAIL", "NHS_APP"

  - `subject` (string)

  - `content` (string, 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