List screener responses - Respondent API

GET

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,
          "selections": [
            {
              "rowUid": "<string>",
              "rowText": "<string>",
              "answerUid": "<string>",
              "answerText": "<string>"
            }
          ],
          "ranking": [
            {
              "uid": "<string>",
              "text": "<string>"
            }
          ],
          "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",
      "invited": true,
      "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>",
          "providerKey": "zoom",
          "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

List responses

Retrieve screener responses and review participant answers.

Qualify or disqualify

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

Invite qualified participants

Send invitations via Invite Participant.

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[]

Hide child attributes

results.qualified

boolean

required

results.percentage

number

required

results.status

enum<string>

required

Available options:

PENDING,

INVITED,

SCHEDULED,

ATTENDED,

NOSHOW,

INVALIDRESPONSE,

REJECTEDQUALITY,

PAID,

CANCELLED

results.responses

object[]

required

Hide child attributes

results.responses.questionId

string

required

results.responses.questionText

string

required

results.responses.type

string

required

results.responses.questionType

enum<string>

required

Available options:

radio,

multiLineTextbox,

checkbox,

singleLineTextbox,

numericBox,

sliderScale,

fileUpload,

rank,

matrix

results.responses.answers

object[]

required

Hide child attributes

results.responses.answers.id

string

required

results.responses.answers.uid

string

required

results.responses.answers.text

string

required

results.responses.answers.answerValue

number

required

results.responses.answers.goToQuestionUid

string | null

results.responses.answers.isOther

boolean

results.responses.answers.other

string

results.responses.qualify

boolean

required

results.responses.order

number

results.responses.selections

object[]

Hide child attributes

results.responses.selections.rowUid

string

required

results.responses.selections.rowText

string

required

results.responses.selections.answerUid

string

required

results.responses.selections.answerText

string

required

results.responses.ranking

object[]

Hide child attributes

results.responses.ranking.uid

string

required

results.responses.ranking.text

string

required

results.responses.skipped

boolean

Only present when the screener-responses-include-skipped-questions feature flag is enabled for the calling organization (default OFF). true when the participant did not answer this question — either because they chose to skip an optional question (skippedBy: user) or because skip-logic on a previous question routed them past it (skippedBy: skipLogic).

results.responses.skippedBy

enum<string>

Only present when the screener-responses-include-skipped-questions feature flag is enabled for the calling organization (default OFF). user means the participant saw the question and chose to skip it; skipLogic means the participant never saw it because skip-logic on a previous question routed past it. Absent on items where skipped is not true.

Available options:

user,

skipLogic

results.responses.shown

boolean

Only present when the screener-responses-include-skipped-questions feature flag is enabled for the calling organization (default OFF). true for answered questions and user-skipped questions (i.e. the participant saw the question); false for skip-logic-skipped questions (the participant never saw it).

results.totalTime

number

required

results.matching

object

required

Hide child attributes

results.matching.isGenderMatch

boolean

required

results.matching.isAgeMatch

boolean

required

results.matching.isEthnicityMatch

boolean

required

results.matching.isEducationMatch

boolean

required

results.matching.questionsQualified

boolean

required

results.matching.isLocationMatch

boolean

required

results.matching.isIndustryMatch

boolean

required

results.matching.isJobTitleMatch

boolean

required

results.matching.isHouseholdIncomeMatch

boolean

required

results.matching.isCompanySizeMatch

boolean

required

results.matching.isTopicsMatch

boolean

results.visibility

object

required

The visibility status of the screener response. If a screener response is visible, it can be interacted with (invited etc). If a screener response is not visible, it cannot be interacted with. A screener may be hidden for various reasons, and a screener can change from visible to not visible at any time if a participant or screener is found to be untrustworthy. There is a webhook that will notify the client when a screener response changes visibility.

Hide child attributes

results.visibility.status

enum<string>

default:VISIBLE

required

Available options:

DISMISSED,

VISIBLE,

ONHOLD

results.id

string

required

results.projectId

string

required

results.userId

string

required

results.qualifiedPendingIdVerification

boolean

This property is set to true (with qualified set to false) if the participant has qualified based on their responses to the screener, but is in the process of verifying their identity.
Once the participant has completed ID verification, qualifiedPendingIdVerification will be set to false.
- If the verification was successful, qualified will be set to true.
- If the verification failed, qualified will remain set to false unless they were manually qualified through the qualification endpoint (PATCH /projects/{projectId}/screener-responses/{screenerResponseId}/qualify).

results.favorite

boolean

results.hidden

boolean

results.isNew

boolean

results.inviteSentAt

string<date-time>

results.invited

boolean

results.scheduledAt

string<date-time>

results.statusUpdatedAt

string<date-time>

results.ndaUrl

string

results.ndaAgree

boolean

results.project

object

Hide child attributes

results.project.name

string

required

results.project.incentive

number

required

results.project.id

string

required

results.project.organizationId

string

required

results.project.teamId

string

required

results.profile

object

Hide child attributes

results.profile.id

string<ObjectId>

required

results.profile.userId

string<ObjectId>

required

results.profile.firstName

string

required

results.profile.lastName

string

required

results.profile.skills

object[]

required

Hide child attributes

results.profile.skills.id

string<ObjectId>

required

results.profile.skills.name

string

required

results.profile.skills.slug

string

required

results.profile.skills.validated

boolean

default:false

required

results.profile.skills.type

string

default:skill

required

results.profile.picture

string | null

results.externalProject

object

Hide child attributes

results.externalProject.researcherId

string

required

results.externalProject.bookingUrl

string

results.externalProject.meetingCancelLink

string

Link to cancel a meeting. If not set, bookingLink will be used.

results.externalProject.bookedDate

string<date-time>

results.externalProject.timezone

string

IANA timezone. Example: 'America/New_York'

results.invitation

object

Hide child attributes

results.invitation.id

string<ObjectId>

required

results.invitation.remoteCommunicationDetails

string

results.invitation.event

object

Hide child attributes

results.invitation.event.uid

string

required

results.invitation.message

string

This will override the special instructions from the project.

results.invitation.videoProvider

object

Hide child attributes

results.invitation.videoProvider.providerKey

enum<string>

required

Available options:

zoom

results.invitation.videoProvider.userId

string

required

results.actor

enum<string>

Available options:

researcher,

respondent,

admin

results.reason

enum<string>

Available options:

time,

final

results.shortNoticeCancel

boolean

results.message

string

results.rejection

object

Hide child attributes

results.rejection.message

string

required

results.rejection.rejectedAt

string<date-time>

required

results.createdAt

string<date-time>

results.task

object

Hide child attributes

results.task.completedAt

string

Timestamp when the task was completed. This field is automatically set when participants access the project's completionUrl.

Last modified on March 18, 2026

View a specific responseRetrieve a single screener response including the participant's answers, profile data, and current status.

⌘I

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,
          "selections": [
            {
              "rowUid": "<string>",
              "rowText": "<string>",
              "answerUid": "<string>",
              "answerText": "<string>"
            }
          ],
          "ranking": [
            {
              "uid": "<string>",
              "text": "<string>"
            }
          ],
          "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",
      "invited": true,
      "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>",
          "providerKey": "zoom",
          "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

Headers

Path Parameters

Query Parameters

Response

Typical workflow