---
title: "Returns the respondents for which all the specified fields match the provided values."
method: GET
path: "/respondents/{surveyId}/Find"
tags: ["Respondents"]
---

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

`GET /respondents/{surveyId}/Find`

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

## Path parameters

- `surveyId` integer, required

## Query parameters

- `respondentId` integer
- `email` string
- `phone` string
- `pin` string
- `panelistId` integer

## Headers

- `Accept-Version` string

## Response `200`

Get the respondents matching the provided values

- RespondentValueResult[]
  - `Id` integer — The respondent's ID.
  - `Pin` string — The respondent's PIN.
  - `Language` string — The respondent's language.
  - `Email` string — The respondent's email address.
  - `EmailStatus` integer — 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)
  - `Phone` string — The respondent's phone number.
  - `PhoneStatus` integer — 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)
  - `TimeZone` string — The respondent's time zone.
  - `Disposition` integer — 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)
  - `TotalDuration` integer — The total duration of the respondent's survey sessions in seconds.
  - `Active` boolean — Indicates whether the respondent is active or inactive.
  - `Simulated` boolean — Indicates whether the respondent's responses were simulated or not.
  - `Device` DeviceDefinition — The device definition.
    - `Type` 'Unknown' | 'Desktop' | 'Smartphone' | 'Tablet' | 'Unsupported' — The device type.
    - `OS` 'Unknown' | 'Android' | 'Bada' | 'BlackBerry' | 'BlackBerry_Tablet_OS' | 'Brew' | 'Feature_Phone_OS' | 'IOS' | 'Limo' | 'Linux' | 'Mac_OS' | 'Mac_OS_X' | 'Maemo' | 'Meego' | 'Not_A_Device' | 'PalmOS' | 'Series_40' | 'Symbian' | 'WebOS' | 'Windows' | 'Windows_Mobile' | 'Windows_Phone' | 'Chrome_OS' | 'Free_BSD' | 'Sun_OS' | 'Mobile_Preview' — The device operating system.
    - `OSVersion` string — The device operating system version.
    - `Browser` 'Unknown' | 'BlackBerry_Browser' | 'Chrome' | 'Dalvik' | 'Dolfin' | 'Firefox' | 'IE' | 'IE_Mobile' | 'Jasmine' | 'Mobile_Safari' | 'Netfront' | 'Nokia_Browser' | 'Not_A_Browser' | 'Opera' | 'Opera_Mini' | 'Opera_Mobile' | 'Safari' | 'Facebook_App' | 'Konqueror' | 'Android_Browser' | 'Chrome_IOS' | 'Lynx' | 'Web_OS_Browser' | 'Thunderbird' | 'Edge' — The device browser.
    - `BrowserVersion` string — The device browser version.
  - `Location` integer — The respondent's location. Available values: 0 = Server, 1 = Device
  - `OfflineUserId` integer — The ID of the Mobile Offline user to which the respondent is assigned.
  - `OfflineUserName` string — The username of the Mobile Offline user to which the respondent is assigned.
  - `OfflineUUID` string — The client-generated UUID to prevent duplicate respondents from Mobile Offline.
  - `FirstActivity` string, date-time — The date and time the respondent first took the survey.
  - `LastActivity` string, date-time — The date and time the respondent last took the survey.
  - `AppointmentDate` string, date-time — The date and time the interview is scheduled in Mobile Offline.
  - `ModifiedOn` string, date-time — The date and time the respondent was last modified.
  - `LastAnsweredQuestion` string — The last question answered by the respondent.
  - `LastAnswerDate` string, date-time — The date and time the respondent answered a question for the last time.
  - `AccessExpirationDate` string, date-time — The date and time that access to the survey expires for the respondent.
  - `IsAnonymized` boolean — Indicates whether the respondent was anonymized or not.
  - `PanelistId` integer — The panelist ID to which the respondent is assigned.
  - `IsPersonalInformationObfuscated` boolean — Indicates whether the respondent's personally identifiable information (PII) have been obfuscated or not.

## Other responses

- `401` — The request must be authenticated using the Authorization HTTP header
- `403` — The authenticated user does not have permission to view respondents in this survey.
- `404` — The requested survey does not exist.

---

[API](https://skmtc.net/voxco/apis/acuity-webapi-1-0.md) · [All operations](https://skmtc.net/voxco/apis/acuity-webapi-1-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/voxco/acuity-webapi-1-0/revisions/2ea4b8555197/schema)