Skip to main content
GET
/
v1
/
projects
/
{projectId}
/
screener-responses
List screener responses
curl --request GET \
  --url https://api-staging.respondent.io/v1/projects/{projectId}/screener-responses \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-secret: <x-api-secret>'
{
  "page": 1,
  "pageSize": 50,
  "totalResults": 123,
  "results": [
    {
      "qualified": true,
      "percentage": 123,
      "responses": [
        {
          "questionId": "<string>",
          "questionText": "<string>",
          "type": "<string>",
          "answers": [
            {
              "id": "<string>",
              "uid": "<string>",
              "text": "<string>",
              "answerValue": 123,
              "goToQuestionUid": "<string>",
              "isOther": true,
              "other": "<string>"
            }
          ],
          "qualify": true,
          "order": 123,
          "skipped": true,
          "shown": true
        }
      ],
      "totalTime": 123,
      "matching": {
        "isGenderMatch": true,
        "isAgeMatch": true,
        "isEthnicityMatch": true,
        "isEducationMatch": true,
        "questionsQualified": true,
        "isLocationMatch": true,
        "isIndustryMatch": true,
        "isJobTitleMatch": true,
        "isHouseholdIncomeMatch": true,
        "isCompanySizeMatch": true,
        "isTopicsMatch": true
      },
      "visibility": {
        "status": "VISIBLE"
      },
      "id": "<string>",
      "projectId": "<string>",
      "userId": "<string>",
      "qualifiedPendingIdVerification": true,
      "favorite": true,
      "hidden": true,
      "isNew": true,
      "inviteSentAt": "2023-11-07T05:31:56Z",
      "scheduledAt": "2023-11-07T05:31:56Z",
      "statusUpdatedAt": "2023-11-07T05:31:56Z",
      "ndaUrl": "<string>",
      "ndaAgree": true,
      "project": {
        "name": "<string>",
        "incentive": 123,
        "id": "<string>",
        "organizationId": "<string>",
        "teamId": "<string>"
      },
      "profile": {
        "id": "<string>",
        "userId": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "skills": [
          {
            "id": "<string>",
            "name": "<string>",
            "slug": "<string>",
            "validated": false,
            "type": "skill"
          }
        ],
        "picture": "<string>"
      },
      "externalProject": {
        "researcherId": "<string>",
        "bookingUrl": "<string>",
        "meetingCancelLink": "<string>",
        "bookedDate": "2023-11-07T05:31:56Z",
        "timezone": "<string>"
      },
      "invitation": {
        "id": "<string>",
        "remoteCommunicationDetails": "<string>",
        "event": {
          "uid": "<string>"
        },
        "message": null,
        "videoProvider": {
          "loginProviderId": "<string>",
          "userId": "<string>"
        }
      },
      "shortNoticeCancel": true,
      "message": "<string>",
      "rejection": {
        "message": "<string>",
        "rejectedAt": "2023-11-07T05:31:56Z"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "task": {
        "completedAt": "<string>"
      }
    }
  ]
}

​
Typical workflow

1

List responses

Retrieve screener responses and review participant answers.
2

Qualify or disqualify

Use Qualify Participant to approve or reject based on screener answers.
3

Invite qualified participants

Send invitations via Invite Participant.
4

Mark attendance and pay

After the session, use Mark as Attended to trigger payment.

Headers

​
x-api-key
string
required
​
x-api-secret
string
required

Path Parameters

​
projectId
string
required

Query Parameters

​
page
number
default:1

Specifies which page of results to return

​
pageSize
number
default:50

Number of records to return per page

​
includeCount
boolean
default:false

If true, includes the total count of records

​
hidden
boolean
default:false
​
status
enum<string>
Available options:
PENDING,
INVITED,
SCHEDULED,
ATTENDED,
NOSHOW,
INVALIDRESPONSE,
REJECTEDQUALITY,
PAID,
CANCELLED
​
statuses
enum<string>[]
Available options:
PENDING,
INVITED,
SCHEDULED,
ATTENDED,
NOSHOW,
INVALIDRESPONSE,
REJECTEDQUALITY,
PAID,
CANCELLED
​
qualified
boolean
​
favorite
boolean
​
visibilityStatus
enum<string>
default:VISIBLE
Available options:
DISMISSED,
VISIBLE,
ONHOLD

Response

200 - application/json
​
page
number
default:1
required
​
pageSize
number
default:50
required
​
totalResults
number

The total number of results possible, which is only provided in the response when includeCount is passed as true within a request.

​
results
object[]