Get Recipients (paged)
GET https://rest.webropolsurveys.com/api/v1/surveys/{{SurveyId}}/recipients/list?page=1
Request uses paging. With GET use ?page=
and page number in URL to return recipients from specified page.
Request returns max 500 recipients for one survey that is specified in the request with the SurveyId.
If you are using loop IsLastItemFetched will tell if the last page is fetched.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
page | number |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
[{"RecipientId":"3809b2c8-773e-420b-966a-073d7jj79ds8","SurveyId":"b154d4f3-ed9g-4212-948d-abf1b83f0233","Email":"test_user@webropol.com","Phone":"+23445324234","FirstName":"Test","LastName":"Respondent","UserAdded":"2023-10-11T10:21:45.667","RecipientStatus":"Initial","Status":0,"EmailsSent":1,"ResponsesStatus":1,"FeedbackSurveyId":null,"UserName":"@vdsx3j6y","Password":"01785446","PersonalLinkToSurvey":"https://link.webropolsurveys.com/M/2805325687DFF329","PersonalLinkToResponseReporting":"https://api.webropolsurveys.com/Report/ViewResponseReport?formId=5715950b-5093-4e3a-afa4-561sf1fe3d21\u0026responseId=208f5c1e-2dg6-48a1-b47a-e1068814dd81"},{"RecipientId":"5g89b2c8-179e-a20b-966a-073d7jj71d0h","SurveyId":"h674d4g3-ed9g-11j9-948d-abf1b83f0219","Email":"test_user2@webropol.com","Phone":"+23445324211","FirstName":"Test 2","LastName":"Respondent 2","UserAdded":"2023-10-11T10:21:45.667","RecipientStatus":"Initial","Status":0,"EmailsSent":1,"ResponsesStatus":1,"FeedbackSurveyId":null,"UserName":"@tds23jby","Password":"42785246","PersonalLinkToSurvey":"https://link.webropolsurveys.com/M/112232568GGFS100","PersonalLinkToResponseReporting":"https://api.webropolsurveys.com/Report/ViewResponseReport?formId=2g35950b-1093-1e3a-afa4-561sf1fe3d21\u0026responseId=198f5c1e-2dg6-48a1-b47a-e1068814ds213"},{"RecipientId":"20002c8-773e-420b-966a-073d7jg0§2g5","SurveyId":"C224d4f3-ed7g-0017-948d-bbf1b83f0297","Email":"test_user3@webropol.com","Phone":"+234453211005","FirstName":"Test 3","LastName":"Respondent 3","UserAdded":"2023-10-11T10:21:45.667","RecipientStatus":"Initial","Status":0,"EmailsSent":1,"ResponsesStatus":1,"FeedbackSurveyId":null,"UserName":"@ghsx2jay","Password":"83483941","PersonalLinkToSurvey":"https://link.webropolsurveys.com/M/1805325687DFF956","PersonalLinkToResponseReporting":"https://api.webropolsurveys.com/Report/ViewResponseReport?formId=2345951b-5093-4e3a-afa4-561sf1fe3d21\u0026responseId=508f5c1e-2dg6-48a1-b47a-e1068814g645"}]