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
Pagestarts at0NumPerPagemaximum value is200OrderByonly supportscreate_timeandupdate_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 Name | Type | Description |
|---|---|---|
| Action | string | Fixed value GetSenderListResponse |
| RetCode | int | Return code, 0 indicates success |
| Message | string | Success or error message |
| RequestUuid | string | Request UUID |
| Total | int64 | Total matched records |
| Data | array | Sender list |
Data Item Fields
| Field Name | Type | Description |
|---|---|---|
| SenderId | string | Sender ID |
| SenderType | int | 0 default sender, 1 single sender |
| Domain | string | Domain |
| {/* | TriggerType | int |
| string | Sender email | |
| Alias | string | Sender alias |
| AccountId | int | Project ID |
| IsDefault | int | Default sender flag |
| Status | int | 0 disabled, 1 enabled |
| CreateTime | int64 | Creation time (Unix seconds) |
| UpdateTime | int64 | Update 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.