Get Recipients
GET https://rest.webropolsurveys.com/api/v1/surveys/{{SurveyId}}/recipients/all
Adds one or more recipients that need to have an Email defined, other optional values are PhoneNumber, FirstName, LastName. Additionally recipients can be added to a recipientgroup if the RecipientGroupId is known.
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
"[\n {\n \"RecipientId\": \"3809b2c8-773e-420b-966a-073d7jj79ds8\",\n \"SurveyId\": \"b154d4f3-ed9g-4212-948d-abf1b83f0233\",\n \"Email\": \"test_user@webropol.com\",\n \"Phone\": \"+23445324234\",\n \"FirstName\": \"Test\",\n \"LastName\": \"Respondent\",\n \"UserAdded\": \"2023-10-11T10:21:45.667\",\n \"RecipientStatus\": \"Initial\",\n \"Status\": 0,\n \"EmailsSent\": 1,\n \"ResponsesStatus\": 1,\n \"FeedbackSurveyId\": null,\n \"UserName\": \"@vdsx3j6y\",\n \"Password\": \"01785446\",\n \"PersonalLinkToSurvey\": \"https://link.webropolsurveys.com/M/2805325687DFF329\",\n \"PersonalLinkToResponseReporting\": \"https://api.webropolsurveys.com/Report/ViewResponseReport?formId=5715950b-5093-4e3a-afa4-561sf1fe3d21\u0026responseId=208f5c1e-2dg6-48a1-b47a-e1068814dd81\"\n },\n{\n \"RecipientId\": \"5g89b2c8-179e-a20b-966a-073d7jj71d0h\",\n \"SurveyId\": \"h674d4g3-ed9g-11j9-948d-abf1b83f0219\",\n \"Email\": \"test_user2@webropol.com\",\n \"Phone\": \"+23445324211\",\n \"FirstName\": \"Test 2\",\n \"LastName\": \"Respondent 2\",\n \"UserAdded\": \"2023-10-11T10:21:45.667\",\n \"RecipientStatus\": \"Initial\",\n \"Status\": 0,\n \"EmailsSent\": 1,\n \"ResponsesStatus\": 1,\n \"FeedbackSurveyId\": null,\n \"UserName\": \"@tds23jby\",\n \"Password\": \"42785246\",\n \"PersonalLinkToSurvey\": \"https://link.webropolsurveys.com/M/112232568GGFS100\",\n \"PersonalLinkToResponseReporting\": \"https://api.webropolsurveys.com/Report/ViewResponseReport?formId=2g35950b-1093-1e3a-afa4-561sf1fe3d21\u0026responseId=198f5c1e-2dg6-48a1-b47a-e1068814ds213\"\n },\n{\n \"RecipientId\": \"20002c8-773e-420b-966a-073d7jg0§2g5\",\n \"SurveyId\": \"C224d4f3-ed7g-0017-948d-bbf1b83f0297\",\n \"Email\": \"test_user3@webropol.com\",\n \"Phone\": \"+234453211005\",\n \"FirstName\": \"Test 3\",\n \"LastName\": \"Respondent 3\",\n \"UserAdded\": \"2023-10-11T10:21:45.667\",\n \"RecipientStatus\": \"Initial\",\n \"Status\": 0,\n \"EmailsSent\": 1,\n \"ResponsesStatus\": 1,\n \"FeedbackSurveyId\": null,\n \"UserName\": \"@ghsx2jay\",\n \"Password\": \"83483941\",\n \"PersonalLinkToSurvey\": \"https://link.webropolsurveys.com/M/1805325687DFF956\",\n \"PersonalLinkToResponseReporting\": \"https://api.webropolsurveys.com/Report/ViewResponseReport?formId=2345951b-5093-4e3a-afa4-561sf1fe3d21\u0026responseId=508f5c1e-2dg6-48a1-b47a-e1068814g645\"\n },\n]"