Retrieve a specific project
Retrieve full details for a single project, including configuration, targeting criteria, and current status.
Response
Kind of research to be conducted for this project. Details here.
If typeOfResearch == inPerson → allowed values are: [oneOnOne, focusGroup, inRespondentHome, inRespondentOffice]
If typeOfResearch == remote → allowed values are: [oneOnOne, focusGroup, unmoderatedStudy, survey, diaryStudy]
oneOnOne, focusGroup, inRespondentHome, inRespondentOffice, unmoderatedStudy, survey, diaryStudy Dollars ranging: Min 5 and Max 1000. Pro tip: Set your incentive at or above $2 per minute (B2C) or $3 per minute (B2B) to attract quality participants faster. More tips to pick the right incentive: https://help.respondent.io/en/articles/5471087-what-is-the-best-incentive-for-my-research-project
External-screener organizations only. The URL of your own screener:
participants who qualify on the Respondent screener are sent here to
complete yours, with respondent_* correlation parameters appended
(respondent_user_id, respondent_profile_id,
respondent_screener_response_id, respondent_project_id). Post their
answers back with the External Screener Answers endpoint before
redirecting them to the apply page they came from — never to the
project's completionUrl. Pairs with externalQuestions: a project may
hold just the link while it is a draft (declare the catalog later through
the external-screener-questions bulk endpoint), but publishing requires
the two together. Can also be set or changed on a published project via
Update a project (but not cleared while externalQuestions are
declared) — participants already handed off keep the URL they were sent
to; new applicants get the new one. Must be an absolute https:// URL:
participants are redirected to it with their correlation ids in the
query string, and a bare hostname cannot be turned into a link.
External-screener organizations only. The declared catalog of your
screener's questions: answer rows are validated against these
questionIds, and the application reads as submitted once every declared
question has an answer (or an answers payload says complete: true).
Also settable via the external-screener-questions bulk endpoint. Pairs
with externalScreenerLink: publishing requires the two together.
Use targetCountries instead.
AX, AL, DZ, AS, AD, AI, AQ, AG, AR, AM, AW, AU, AT, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, VG, IO, BN, BG, BF, BI, CV, CM, CA, KY, CF, TD, CL, CX, CC, CO, KM, CG, CK, CR, HR, CU, CW, CY, CZ, CI, CD, DK, DJ, DM, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, LA, LV, LB, LR, LY, LI, LT, LU, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, NA, NR, NP, NL, NC, NZ, NI, NE, NU, NF, KP, MK, MP, NO, OM, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RW, RE, SH, KN, LC, PM, VC, WS, SM, ST, SA, RS, SC, SL, SG, SK, SI, SB, SO, ZA, GS, KR, ES, LK, SR, SJ, SE, CH, TZ, TW, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, AE, GB, UM, US, UY, VU, VE, VN, WF, EH, ZM, ZW, all Use targetCountries instead.
AX, AL, DZ, AS, AD, AI, AQ, AG, AR, AM, AW, AU, AT, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, VG, IO, BN, BG, BF, BI, CV, CM, CA, KY, CF, TD, CL, CX, CC, CO, KM, CG, CK, CR, HR, CU, CW, CY, CZ, CI, CD, DK, DJ, DM, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, LA, LV, LB, LR, LY, LI, LT, LU, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, NA, NR, NP, NL, NC, NZ, NI, NE, NU, NF, KP, MK, MP, NO, OM, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RW, RE, SH, KN, LC, PM, VC, WS, SM, ST, SA, RS, SC, SL, SG, SK, SI, SB, SO, ZA, GS, KR, ES, LK, SR, SJ, SE, CH, TZ, TW, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, AE, GB, UM, US, UY, VU, VE, VN, WF, EH, ZM, ZW, all Available for Industry professionals (B2B) projects
accountingAuditing, administrative, advertising, analyst, artCreative, businessDevelopment, consulting, customerService, distribution, design, education, finance, generalBusiness, healthcareProvider, humanResources, informationTechnology, legal, management, manufacturing, marketing, other, publicRelations, purchasing, productManagement, projectManagement, production, qualityAssurance, research, sales, science, strategyPlanning, supplyChain, training, writingEditing - If researcher wants to filter out participants who have participated in past projects.
- Past Participation logic is used at Researcher level based on external reseacher id.
- The participant must have been paid for a project to count as a past participant.
- Past participation filtering is available within 4 hours of a payout being made, NOT immediately after payment.
- Autopay is used to automatically pay participants after they complete a project.
- If not provided, defaults to
true.
- If not provided, defaults to
- Autoinvite is used to automatically invite participants to a project if they qualify after completing the screener.
- Only available when
targetResearchMethodologyis one of: [unmoderatedStudy,survey]. - If not provided, defaults to
false.
- Only available when
Converts signals into required match filters. Details here.
Converts signals into required match filters. Details here.
targetHouseholdIncome, targetProfessionalIndustries, targetCompanySize, targetProjectTopics, targetAudienceSkills, relationshipStatus, languages, numberOfChildren, numberOfChildrenLiveAtHome, childrenBirthYears, livingSituation, pets, homeOwner, nationality, militaryServiceStatus, employmentStatuses, cloudPlatforms, codingAITools, designPrototypingTools, productivitySoftware, streamingServices, foodDeliveryServices, onlineBankingTools, onlineLearningPlatforms, onlineMarketplacePlatforms, onlineTravelBooking, smartHomeDevices, socialNetworkPlatforms, vehicleBrands, healthWellnessApps, onlineShoppingFrequency Flat advanced-targeting attribute map set on this project (relationship
status, languages, devices, products & services, professional and shopping
preferences, …). Present only when the requesting organisation has the
advanced-targeting-attributes feature flag enabled. All advanced
attributes appear identically on B2C and B2B projects.