# Listing of unsubscribed e-mails

Endpoint: GET /api/unsubscribed-emails
Version: 1.0.0
Security: shoptetAccessToken, shoptetPrivateApiToken

## Query parameters:

  - `from` (string)
    date of unsubcription (unsubscribedAt in response). Optional.
    Example: "2023-02-01T17:04:47+0100"

  - `itemsPerPage` (integer)
    Returned items per page. Default and max value is 1000.
    Example: 50

  - `page` (integer)
    Page number to return. Default value is 1.
    Example: 3

## Header parameters:

  - `Content-Type` (string, required)

## Response 200 fields (application/json):

  - `data` (object, required)

  - `data.unsubscribedEmails` (array, required)

  - `data.unsubscribedEmails.email` (string, required)
    Email address

  - `data.unsubscribedEmails.unsubscribedAt` (string,null, required)
    Date and time when the email was unsubscribed

  - `data.paginator` (object, required)

  - `data.paginator.totalCount` (integer, required)
    total number of available records

  - `data.paginator.page` (integer, required)
    current page

  - `data.paginator.pageCount` (integer, required)
    total available of pages

  - `data.paginator.itemsOnPage` (integer, required)
    number of currently returned records

  - `data.paginator.itemsPerPage` (integer, required)
    required number of records per page

  - `errors` (array,null, required)

  - `errors.errorCode` (string, required)
    Short text error identification

  - `errors.message` (string, required)
    Descriptive error message

  - `errors.instance` (string, required)
    Identification of the entity referenced

  - `metadata` (object, required)

  - `metadata.requestId` (string, required)
    Request identifier. Useful for logging/reporting purposes.