GET

List Sender Details

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of sender details.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Access Verticals by Automations
Set Up Automations
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/sender-details/v1/sender-details
Query Params
paging.limitintegerminimum 0maximum 100format int32

Number of items to load.

paging.cursorstringmaxLength 1000

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.

Response Object
pagingMetadataPagingMetadata

Paging metadata.

senderDetailsArray <SenderDetails>maxItems 100

List of sender details.

List Sender Details Example 1
Request
cURL
curl 'https://www.wixapis.com/sender-details/v1/sender-details' \
-H 'Authorization: <AUTH>'
Response
JSON
{
  "pagingMetadata": {
    "count": 2,
    "cursors": {},
    "hasNext": false
  },
  "senderDetails": [
    {
      "id": "3dcaeca5-2b09-441c-86ab-808d85061511",
      "createdDate": "2024-01-01T00:00:00.000Z",
      "updatedDate": "2024-01-01T00:00:00.000Z",
      "fromName": "John Doe",
      "fromEmailAddress": "john.doe@example.com",
      "default": true
    },
    {
      "id": "a6351a69-f4cb-411c-9853-26634468b03d",
      "createdDate": "2024-01-01T00:00:00.000Z",
      "updatedDate": "2024-01-01T00:00:00.000Z",
      "fromName": "Jane Doe",
      "fromEmailAddress": "jane.doe@example.com",
      "default": false
    }
  ]
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?