Skip to main content

  1. ​
    How do I test the respondent flow in staging without recruiting real participants?

    You create a participant profile in staging via our profile creation endpoint. You can then invite that profile by following these steps:
    1. Log into the staging participant profile in one browser tab.
    2. In another tab (recommend opening in incognito), log into the researcher side.
    3. Open a published project and look for the Share button in the top-right corner.
    4. Copy the project link and switch back to the staging participant profile tab.
    5. Paste the link into the search bar of the staging participant profile. The staging participant should then be able to access the screener.

  2. ​
    What is an externalResearcherId?

    An externalResearcherId is a custom identifier that the API partner assigns to researchers when creating projects via our API.

  3. ​
    What parameters are appended to the task URL?

    • respondent_profile_id
    • respondent_project_id
    • respondent_screener_response_id
    • respondent_user_id
    • month

  4. ​
    How do I get staging API credentials?

    Staging credentials (x-api-key and x-api-secret) are issued by the Respondent Partner team — they are not self-serve. To request them:
    1. Follow the Quickstart and book an intro call with the Partner team.
    2. After the intro call, Respondent will provision a staging Researcher account and API credentials for your organization.
    3. Treat staging tokens as real credentials and keep them out of logs, screenshots, and recordings.
    See Staging environment for the staging base URL and test data once you have credentials.

  5. ​
    What does qualifiedOverriden mean on a screener response?

    qualifiedOverriden is a boolean on the Qualify Participant request body and on the screener response itself. It indicates whether the participant’s qualified status was set manually by a researcher (via the qualify endpoint or the researcher UI) rather than by the automatic screener evaluation.
    • false — the qualified status reflects the participant’s screener answers as evaluated by Respondent.
    • true — a researcher overrode the automatic result, for example to manually qualify a participant whose screener marked them as qualified: false.
    Use this field to distinguish system-qualified participants from manually qualified ones when auditing screener decisions.

  6. ​
    How do I retrieve participants I’ve reported?

    The Report Participant endpoint sets the participant’s status to Reported, after which no further actions are available on that response. The status query parameter on List Screener Responses does not include REPORTED, so reported participants cannot be filtered by status directly. To track reported participants, persist the screenerResponseId (and any other identifiers you need) on your side at the time you call Report Participant. Reported participants are also prevented from applying to your organization’s future projects automatically — see Response statuses for the full status lifecycle.

  7. ​
    What are some tips and tricks to maximise your integration?

    • autopay is set to true. If set to false, you will need to manually login onto our DIY platform to process payment or use our manual payout endpoint with payoutCount: 1.
    • Use the Retrieve Audience Size Estimate endpoint to test feasibility — it can be called multiple times as you adjust filters and signals.
    • Use the Qualify Participant endpoint: For qualifying or disqualifying participants based on their screener responses—any disqualified participant will automatically be backfilled.
    • Use the Mark As Rejectedendpoint: For when the participant response to the study does not meet researcher’s criteria.
    • Use the Report Participant endpoint: For flagging participants for inappropriate behavior. Reported participants won’t appear in future projects.
    • Enable messaging with participants through our messaging flow to boost show and task completion rates.
    • Enable the past participant database feature to unlock the ability to filter out participants who’ve taken part in previous studies, or to selectively re-invite high-quality (favorite) participants.
    • When a project reaches 3x the target number of participants, it is automatically paused. To continue recruitment, simply unpause the project.
Last modified on June 16, 2026