# Get the status of recent email notifications sent from Elevate

Endpoint: GET /email-status
Version: 1.0
Security: bearerAuth

## Query parameters:

  - `page` (integer, required)
    Page of results to show
    Example: 1

  - `pageSize` (integer, required)
    Results to return per page
    Example: 100

  - `sort` (string)
    Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change
    Example: "id,name | name:desc"

  - `fields` (string)
    Comma-delimited list of the field(s) to return if only a subset is required
    Example: "id,name"

  - `createdDateTime` (string, required)
    Filter by email notifications created before or after this timestamp
    Example: "yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ"

  - `updatedDateTime` (string)
    Filter by email notification status updated before or after this timestamp
    Example: "yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ"

  - `billRunType` (string)
    Filter by bill run type
    Enum: "NORMAL", "ADHOC"

  - `billRunId` (string)
    Filter by bill run identifier
    Example: "0"

  - `status` (string)
    Filter by email notification status
    Enum: "SENT", "DELIVERED", "BOUNCED", "COMPLAINT", "ERROR", "ACKNOWLEDGED", "RETRY"

  - `bounceType` (string)
    Filter by email bounce type (also filters to BOUNCED email notification status)
    Enum: "PERMANENT", "TRANSIENT"

## Response 200 fields (application/json):

  - `id` (integer)
    Email notification status identifier
    Example: 1

  - `recipientEmail` (string)
    Recipient email address

  - `createdDateTime` (string)
    Email notification created time

  - `updatedDateTime` (string)
    Email notification status last updated time

  - `status` (string)
    Status of email notification
    Enum: "SENT", "DELIVERED", "BOUNCED", "COMPLAINT", "ERROR", "ACKNOWLEDGED", "RETRY"

  - `message` (string)
    Status message including any reason for email bounce or complaint
    Example: "failed, 5.3.0, smtp; 550 RCPT TO:<xxxxxx@imperatives.co.uk> User unknown"

  - `bounceType` (string)
    Bounce type
    Enum: "PERMANENT", "TRANSIENT"

  - `billRunType` (string)
    Billing run type
    Enum: "NORMAL", "ADHOC"

  - `billRunId` (integer)
    Bill run identifier that the notification was linked to
    Example: 1

  - `customerId` (integer)
    Customer identifier
    Example: 1

  - `siteId` (integer)
    Site identifier
    Example: 1

  - `contactId` (integer)
    Site contact identifier
    Example: 1


## Response 400 fields

## Response 401 fields

## Response 403 fields