Sign in
latestOpenAPI 3.0.12026-08-10254561.9 KB

2ea4b8555197

Respondents

Returns the respondents for which all the specified fields match the provided values.

User groups who are denied access permission for personally identifiable information (PII) will receive obfuscated data. Only the parameters with a value will be evaluated. You must provide a value for at least one field.
Example: Find a respondent by email address /respondents/12345/find?email=email@voxco.com

get/respondents/{surveyId}/Find

Path parameters

surveyIdinteger required

Survey ID

Query parameters

respondentIdinteger

Use this parameter to find a respondent by its case id

emailstring

Use this parameter to find a respondent by its email address

phonestring

Use this parameter to find a respondent by its phone number

pinstring

Use this parameter to find a respondent by its pin

panelistIdinteger

Use this parameter to find a respondent by its panelist id

Headers

Accept-Versionstring

The requested API version

Response

Get the respondents matching the provided values

Idinteger

The respondent's ID.

Pinstring

The respondent's PIN.

Languagestring

The respondent's language.

Emailstring

The respondent's email address.

EmailStatusinteger

The respondent's email distribution status. Available values: 1 = Sent (the email has been sent, but the respondent has not started the survey), 2 = Started (the respondent has started the survey, but has not completed it), 3 = Bounced (the email was not deliverable), 4 = Completed (the respondent answered the completion question), 5 = None (no email has been sent)

Phonestring

The respondent's phone number.

PhoneStatusinteger

The respondent's SMS distribution status. Available values: 1 = Sent (the SMS has been sent, but the respondent has not started the survey), 2 = Undelivered (the SMS was not deliverable), 3 = None (no SMS has been sent), 4 = Started (the respondent has started the survey, but has not completed it), 5 = Completed (the respondent answered the completion question)

TimeZonestring

The respondent's time zone.

Dispositioninteger

The result of the respondent's last survey session. Available values: 0 = Empty (not started), 1 = Completed (the respondent answered the completion question), 2 = Dropped (the respondent closed the browser or was disconnected before reaching the completion question), 3 = Screened Out (the respondent does not qualify to participate according to the questionnaire logic), 4 = Interrupted (the respondent clicked Quit before reaching the completion question), 5 = Out of Quota (disqualified because the survey quotas were met or closed), 6 = Reset (the status was reset by an administrator)

TotalDurationinteger

The total duration of the respondent's survey sessions in seconds.

Activeboolean

Indicates whether the respondent is active or inactive.

Simulatedboolean

Indicates whether the respondent's responses were simulated or not.

Locationinteger

The respondent's location. Available values: 0 = Server, 1 = Device

OfflineUserIdinteger

The ID of the Mobile Offline user to which the respondent is assigned.

OfflineUserNamestring

The username of the Mobile Offline user to which the respondent is assigned.

OfflineUUIDstring

The client-generated UUID to prevent duplicate respondents from Mobile Offline.

FirstActivitystring date-time

The date and time the respondent first took the survey.

LastActivitystring date-time

The date and time the respondent last took the survey.

AppointmentDatestring date-time

The date and time the interview is scheduled in Mobile Offline.

ModifiedOnstring date-time

The date and time the respondent was last modified.

LastAnsweredQuestionstring

The last question answered by the respondent.

LastAnswerDatestring date-time

The date and time the respondent answered a question for the last time.

AccessExpirationDatestring date-time

The date and time that access to the survey expires for the respondent.

IsAnonymizedboolean

Indicates whether the respondent was anonymized or not.

PanelistIdinteger

The panelist ID to which the respondent is assigned.

IsPersonalInformationObfuscatedboolean

Indicates whether the respondent's personally identifiable information (PII) have been obfuscated or not.