> 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

# ListSenderDetails

# Package: emails

# Namespace: SenderDetailsService

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

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

## Introduction

Retrieves a list of sender details.

---

## REST API

### Schema

```
 Method: listSenderDetails
 Description: Retrieves a list of sender details.
 URL: https://www.wixapis.com/sender-details/v1/sender-details
 Method: GET
 Method parameters:
   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: ListSenderDetailsResponse
  - 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: senderDetails | type: array<SenderDetails> | description: List of sender details. 
     - name: id | type: string | description: Sender details GUID. 
     - name: createdDate | type: string | description: Date and time the sender details were created. 
     - name: updatedDate | type: string | description: Date and time the sender details were last updated. 
     - name: fromName | type: string | description: Sender name. This name appears in the email as "from:" name. 
     - name: fromEmailAddress | type: string | description: Sender email address. Recipients can also reply to this email address.  > **Note:** An email address must be verified using https://dev.wix.com/docs/api-reference/business-management/marketing/emails/sender-emails/introduction.md#sender-email-verification-flow before it can be used to create a sender. 
     - name: default | type: boolean | description: Whether the sender is default. 
     - name: extendedFields | type: ExtendedFields | description: Extensions allowing users to save custom data related to the sender details. 
        - 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

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

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.emails.SenderDetailsService.listSenderDetails(options)
 Description: Retrieves a list of sender details.
 Method parameters:
   param name: options | type: ListSenderDetailsOptions  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. 
 Return type: PROMISE<ListSenderDetailsResponse>
  - 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: senderDetails | type: array<SenderDetails> | description: List of sender details. 
     - name: _id | type: string | description: Sender details GUID. 
     - name: _createdDate | type: Date | description: Date and time the sender details were created. 
     - name: _updatedDate | type: Date | description: Date and time the sender details were last updated. 
     - name: fromName | type: string | description: Sender name. This name appears in the email as "from:" name. 
     - name: fromEmailAddress | type: string | description: Sender email address. Recipients can also reply to this email address.  > **Note:** An email address must be verified using https://dev.wix.com/docs/api-reference/business-management/marketing/emails/sender-emails/introduction.md#sender-email-verification-flow before it can be used to create a sender. 
     - name: default | type: boolean | description: Whether the sender is default. 
     - name: extendedFields | type: ExtendedFields | description: Extensions allowing users to save custom data related to the sender details. 
        - 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

### listSenderDetails
```javascript
import { senderDetails } from '@wix/sender-details';

async function listSenderDetails(options) {
  const response = await senderDetails.listSenderDetails(options);
};
```

### listSenderDetails (with elevated permissions)
```javascript
import { senderDetails } from '@wix/sender-details';
import { auth } from '@wix/essentials';

async function myListSenderDetailsMethod(options) {
  const elevatedListSenderDetails = auth.elevate(senderDetails.listSenderDetails);
  const response = await elevatedListSenderDetails(options);
}
```

### listSenderDetails (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 { senderDetails } from '@wix/sender-details';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

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


async function listSenderDetails(options) {
  const response = await myWixClient.senderDetails.listSenderDetails(options);
};
```

---