Method :POST

URL: https://apiv1.publicators.com/api/Recipients/GetRecipientsEmailsByListid

Get Recipients Emails by list Id

Request Information

URI Parameters

None.

Body Parameters

RecipientsEmailsGetByListIdBindingModel
NameDescriptionTypeAdditional 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": "6472efe3-3551-411f-925e-68baf93bf446"
  },
  "ListId": 1,
  "PermissionType": 1,
  "StartIndex": 1,
  "FetchNext": 1
}

Response Information

Resource Description

RecipientsEmailsGetByListIdViewModel
NameDescriptionTypeAdditional 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
}