# Return filtered email inboxes

POST /v3/email-inboxes/library

Get all email inboxes that meet the filtering criteria

Endpoint: POST /v3/email-inboxes/library
Security: API_Key

## Query parameters:

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

  - `pageSize` (integer)

  - `sortBy` (string)
    Enum: "name", "emailAddress", "messagesReceived", "lastMessageReceived", "testScenariosCount"

  - `sortDesc` (boolean)
    Controls sorting order

## Request fields (application/json):

  - `name` (string)
    Example: "Adobe Campaign Holidays, Marketing Department"

  - `emailAddress` (string)
    Example: "scanTest+<8^[a-z0-9]>-<truncatedInboxName>@email.observepoint.com"

  - `auditIds` (array)
    The ids of the audits to be associated to the Email Inbox

  - `labelIds` (array)
    The ids of the labels to be associated to the Email Inbox
    Example: [223]

  - `createdBy` (array)
    The ids of Email Inbox owners
    Example: [123]

## 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

  - `emailInboxes` (array, required)

  - `emailInboxes.id` (integer)
    Example: 10

  - `emailInboxes.labelIds` (array)
    The ids of the labels associated to the Email Inbox
    Example: [223]

  - `emailInboxes.name` (string)
    Example: "Christmas Marketing Campaign"

  - `emailInboxes.emailAddress` (string)
    The email address that has been assigned to the inbox
    Example: "scanTest+<8^[a-z0-9]>@email.observepoint.com"

  - `emailInboxes.notes` (string)

  - `emailInboxes.messagesReceived` (integer)
    The number of messages received by the Email Inbox

  - `emailInboxes.lastMessageReceived` (string)
    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"

  - `emailInboxes.testScenariosCount` (integer)
    The number of test scenarios performed against the email landing pages.

## 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 403 fields (application/json):

  - `timestamp` (string)

  - `message` (string)

  - `details` (string)

  - `validationReport` (object)