Skip to main content
Get sender identities with optional filters, pagination, and sorting. This endpoint uses HTTP Basic Authentication, and all parameters are passed in query string.

Request Information

  • Get API Key: ACCESSKEY_ID:ACCESSKEY_SECRET
  • Request Method: GET
  • Request Path: /api/v1/email/GetSenderList
  • Content-Type: application/json
  • Parameter Location: Query String

Notes

  • Page starts at 0
  • NumPerPage maximum value is 200
  • OrderBy only supports create_time and update_time
Emailstring
Sender email for exact match
?
Domainstring
Domain for exact match
?
SenderTypenumber
0 default sender, 1 single sender
?
Pagenumber
Page index, starts from 0 (default 0)
?
NumPerPagenumber
Items per page, default 20, max 200
?
OrderBystring
Supported values: create_time, update_time
?
OrderTypestring
Sort order: asc or desc (default desc)
?
FuzzySearchstring
Keyword for fuzzy search
?

Response Format

Field NameTypeDescription
ActionstringFixed value GetSenderListResponse
RetCodeintReturn code, 0 indicates success
MessagestringSuccess or error message
RequestUuidstringRequest UUID
Totalint64Total matched records
DataarraySender list

Data Item Fields

Field NameTypeDescription
SenderIdstringSender ID
SenderTypeint0 default sender, 1 single sender
DomainstringDomain
{/*TriggerTypeint
EmailstringSender email
AliasstringSender alias
AccountIdintProject ID
IsDefaultintDefault sender flag
Statusint0 disabled, 1 enabled
CreateTimeint64Creation time (Unix seconds)
UpdateTimeint64Update time (Unix seconds)

LANGUAGE

CREDENTIALS

👁️
🔒
🔑Log in to get ACCESSKEY_ID and ACCESSKEY_SECRET

URL

GET
CURL Request
curl -X GET "https://api.uspeedo.com/api/v1/email/GetSenderList?Page=0&NumPerPage=20&OrderBy=create_time&OrderType=desc" \
-H "Accept: application/json" \
-H "Authorization: Basic $(echo -n 'ACCESSKEY_ID:ACCESSKEY_SECRET' | base64)"

RESPONSE

Click Try It! to start a request and see the response here.