> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# ListSenderEmails

# Package: emails

# Namespace: SenderEmailService

# Method link: https://dev.wix.com/docs/api-reference/business-management/marketing/emails/sender-emails/list-sender-emails.md

## Permission Scopes:
Access Verticals by Automations: SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS

## Introduction

Retrieves a list of sender emails.

---

## REST API

### Schema

```
 Method: listSenderEmails
 Description: Retrieves a list of sender emails.
 URL: https://www.wixapis.com/sender-emails/v1/sender-emails
 Method: GET
 Method parameters:
   query param name: emailAddress | type: emailAddress | description: Provide a specific email address if you don't want to receive all of a site's sender email addresses. 
   param name: paging | type: CursorPaging   
        - name: limit | type: integer | description: Number of items to load. 
        - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. You can get the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. 
 Return type: ListSenderEmailsResponse
  - name: pagingMetadata | type: CursorPagingMetadata | description: Paging metadata. 
     - name: count | type: integer | description: Number of items returned in the response. 
     - name: cursors | type: Cursors | description: Offset that was requested. 
        - name: next | type: string | description: Cursor pointing to next page in the list of results. 
        - name: prev | type: string | description: Cursor pointing to previous page in the list of results. 
     - name: hasNext | type: boolean | description: Indicates if there are more results after the current page. If `true`, another page of results can be retrieved. If `false`, this is the last page. 
  - name: senderEmails | type: array<SenderEmail> | description: List of sender emails. 
     - name: id | type: string | description: Sender email GUID. 
     - name: createdDate | type: string | description: Date and time the sender email was created. 
     - name: updatedDate | type: string | description: Date and time the sender email was last updated. 
     - name: emailAddress | type: string | description: Sender email address. 
     - name: verified | type: boolean | description: Whether the sender email is verified. 
     - name: extendedFields | type: ExtendedFields | description: Extensions allowing users to save custom data related to the sender emails. 
        - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). 


```

### Examples

### ListSenderEmails
```curl
~~~cURL
curl 'https://www.wixapis.com/sender-emails/v1/sender-emails' \
-H 'Authorization: <AUTH>'
~~~
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.emails.SenderEmailService.listSenderEmails(options)
 Description: Retrieves a list of sender emails.
 Method parameters:
   param name: options | type: ListSenderEmailsOptions  none 
        - name: paging | type: CursorPaging | description: Paging details. 
           - name: limit | type: integer | description: Number of items to load. 
           - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. You can get the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. 
        - name: emailAddress | type: string | description: Provide a specific email address if you don't want to receive all of a site's sender email addresses. 
 Return type: PROMISE<ListSenderEmailsResponse>
  - name: pagingMetadata | type: CursorPagingMetadata | description: Paging metadata. 
     - name: count | type: integer | description: Number of items returned in the response. 
     - name: cursors | type: Cursors | description: Offset that was requested. 
        - name: next | type: string | description: Cursor pointing to next page in the list of results. 
        - name: prev | type: string | description: Cursor pointing to previous page in the list of results. 
     - name: hasNext | type: boolean | description: Indicates if there are more results after the current page. If `true`, another page of results can be retrieved. If `false`, this is the last page. 
  - name: senderEmails | type: array<SenderEmail> | description: List of sender emails. 
     - name: _id | type: string | description: Sender email GUID. 
     - name: _createdDate | type: Date | description: Date and time the sender email was created. 
     - name: _updatedDate | type: Date | description: Date and time the sender email was last updated. 
     - name: emailAddress | type: string | description: Sender email address. 
     - name: verified | type: boolean | description: Whether the sender email is verified. 
     - name: extendedFields | type: ExtendedFields | description: Extensions allowing users to save custom data related to the sender emails. 
        - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). 


```

### Examples

### listSenderEmails
```javascript
import { senderEmails } from '@wix/sender-emails';

async function listSenderEmails(options) {
  const response = await senderEmails.listSenderEmails(options);
};
```

### listSenderEmails (with elevated permissions)
```javascript
import { senderEmails } from '@wix/sender-emails';
import { auth } from '@wix/essentials';

async function myListSenderEmailsMethod(options) {
  const elevatedListSenderEmails = auth.elevate(senderEmails.listSenderEmails);
  const response = await elevatedListSenderEmails(options);
}
```

### listSenderEmails (self-hosted)
Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).

```javascript
import { createClient } from '@wix/sdk';
import { senderEmails } from '@wix/sender-emails';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { senderEmails },
  // Include the auth strategy and host as relevant
});


async function listSenderEmails(options) {
  const response = await myWixClient.senderEmails.listSenderEmails(options);
};
```

---