Method :POST
URL: https://apiv1.publicators.com/api/Recipients/GetRecipientsEmailsByListid
Get Recipients Emails by list Id
Request Information
URI Parameters
None.
Body Parameters
RecipientsEmailsGetByListIdBindingModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Auth | AuthorizationTokenBindingModel |
Required |
|
| ListId |
List Id |
integer |
Required |
| PermissionType |
Set NULL for receiving all statuses. |
RecipientAllPermissionTypes |
None. |
| StartIndex |
Set the paging start index. |
integer |
None. |
| FetchNext |
Get the next X records: Top 1000. |
integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"Auth": {
"Token": "420e2692-90a3-453e-8496-3a0689e543bd"
},
"ListId": 1,
"PermissionType": 1,
"StartIndex": 1,
"FetchNext": 1
}
Response Information
Resource Description
RecipientsEmailsGetByListIdViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| RecipientsEmails | Collection of RecipientsEmailsGetByListId |
None. |
|
| TotalRecords |
Total number of records found |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"RecipientsEmails": [
{
"user_email": "sample string 1",
"PermissionType": 1
},
{
"user_email": "sample string 1",
"PermissionType": 1
}
],
"TotalRecords": 1
}