# Get all email messages associated with a given Email Inbox

GET /v3/email-inboxes/{emailInboxId}/messages

Endpoint: GET /v3/email-inboxes/{emailInboxId}/messages
Security: API_Key

## Path parameters:

  - `emailInboxId` (integer, required)
    Unique identification number for email inbox

## Query parameters:

  - `page` (integer)
    Number of results page of an endpoint with paginated results

  - `size` (integer)

  - `emailSubject` (string)
    filter Email Messages by email subject

## Response 200 fields (application/json):

  - `metadata` (object, required)
    Common metadata for iterable

  - `metadata.pagination` (object, required)

  - `metadata.pagination.totalCount` (integer, required)
    Total number of items available from all result pages combined

  - `metadata.pagination.totalPageCount` (integer, required)
    Total number of pages available

  - `metadata.pagination.pageSize` (integer, required)
    Page size - number of items per result page configured by size query parameter or default page size

  - `metadata.pagination.currentPageSize` (integer, required)
    Number of items in current result page

  - `metadata.pagination.currentPageNumber` (integer, required)
    Current page number/ordinal

  - `messages` (array, required)

  - `messages.id` (integer, required)
    Example: 10

  - `messages.status` (string, required)
    Enum: "RECEIVED", "PROCESSING", "AUDITING", "NOT_AUDITING", "NOTIFYING", "COMPLETE", "FAILED", "CANCELLED"

  - `messages.statusReason` (string)
    Enum: "ITEM_CONCURRENCY_REACHED", "ACCOUNT_CONCURRENCY_REACHED", "USER_CONCURRENCY_REACHED", "USAGE_LIMIT_EXCEEDED_WHEN_OVERAGE_NOT_ALLOWED", "NO_AUDITS_ASSIGNED", "UNABLE_TO_PROCESS_MESSAGE", "NO_LINKS_FOUND", "MESSAGE_NOT_FOUND", "ABORTED", "UNKNOWN"

  - `messages.receivedAt` (string, required)
    Date-time in [RFC3339 profile ISO 8601 format](https://www.ietf.org/rfc/rfc3339.txt) with
the following additional restrictions:
1. An uppercase T must separate the date and time portions.
2. An uppercase Z must denote that a numeric time zone offset isn't present.

In general, these timestamp requirements are the same in
[AWS Step Functions - Choice Rules](https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-choice-state.html)
    Example: "2016-08-18T17:33:00Z"

  - `messages.senderEmailAddress` (string, required)
    Example: "marketing@email.observepoint.com"

  - `messages.subject` (string, required)
    Example: "Christmas Marketing Campaign"

  - `messages.uniqueLinks` (integer, required)
    Example: 317

  - `messages.runs` (array, required)

  - `messages.runs.auditName` (string, required)
    Example: "Audit Name"

  - `messages.runs.auditId` (integer, required)
    Example: 123

  - `messages.runs.runId` (integer, required)
    Example: 123

  - `messages.runs.isCompleted` (boolean)
    TRUE if the audit run is completed, otherwise FALSE

  - `messages.screenshotPath` (string, required)
    A url that redirects to a time-limited screenshot of the email.
    Example: "/v2/screenshots?token=a.b.c"

  - `messages.screenshotThumbnailPath` (string, required)
    Provides a smaller resolution screenshot than the screenshot property.
    Example: "/v2/screenshots?token=a.b.c"

## Response 400 fields (application/json):

  - `timestamp` (string)

  - `message` (string)

  - `details` (string)

  - `validationReport` (object)

## Response 401 fields (application/json):

  - `timestamp` (string)

  - `message` (string)

  - `details` (string)

  - `validationReport` (object)

## Response 404 fields (application/json):

  - `timestamp` (string)

  - `message` (string)

  - `details` (string)

  - `validationReport` (object)