Project Management
Retrieve all projects
List all projects in your organization. Closed projects are excluded by default — use the status filter to include them.
GET
/
v1
/
projects
Retrieve all projects
curl --request GET \
--url https://api-staging.respondent.io/v1/projects \
--header 'x-api-key: <x-api-key>' \
--header 'x-api-secret: <x-api-secret>'import requests
url = "https://api-staging.respondent.io/v1/projects"
headers = {
"x-api-key": "<x-api-key>",
"x-api-secret": "<x-api-secret>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-api-key': '<x-api-key>', 'x-api-secret': '<x-api-secret>'}
};
fetch('https://api-staging.respondent.io/v1/projects', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-staging.respondent.io/v1/projects",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <x-api-key>",
"x-api-secret: <x-api-secret>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-staging.respondent.io/v1/projects"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<x-api-key>")
req.Header.Add("x-api-secret", "<x-api-secret>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-staging.respondent.io/v1/projects")
.header("x-api-key", "<x-api-key>")
.header("x-api-secret", "<x-api-secret>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-staging.respondent.io/v1/projects")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'
request["x-api-secret"] = '<x-api-secret>'
response = http.request(request)
puts response.read_body{
"page": 1,
"pageSize": 50,
"results": [
{
"createdAt": "<string>",
"publicTitle": "<string>",
"publicInternalName": "<string>",
"participantTimeRequiredMinutes": 123,
"incentiveAmount": 123,
"targetNumberOfParticipants": 123,
"externalResearcher": {
"researcherId": "<string>",
"researcherName": "<string>",
"teamId": "<string>",
"companyName": "<string>",
"companyId": "<string>",
"bookingUrl": "<string>"
},
"id": "<string>",
"updatedAt": "<string>",
"publicDescription": "<string>",
"organizationId": "<string>",
"teamId": "<string>",
"unmoderatedStudyOrSurvey": {
"remoteCommunicationDetails": "<string>",
"specialInstructions": "<string>"
},
"targetCountries": [],
"targetCities": [
{
"location": {
"city": "<string>",
"location": {
"longitude": 123,
"latitude": 123
},
"id": "<string>",
"googleId": "<string>",
"region": "<string>",
"state": "<string>",
"zipcode": "<string>",
"address1": "<string>",
"formattedAddress": "<string>"
}
}
],
"targetJobFunctions": [],
"targetCompanySize": [],
"targetLocationRespondentInPerson": {
"address1": "<string>",
"city": "<string>",
"formattedAddress": "<string>",
"latitude": 123,
"longitude": 123,
"id": "<string>",
"zipcode": "<string>",
"region": "<string>",
"state": "<string>"
},
"targetHouseholdIncome": [],
"targetEducation": [],
"targetEthnicities": [],
"targetAgeGroups": [],
"screenerQuestions": [
{
"createdAt": "<string>",
"text": "<string>",
"minValue": 123,
"maxValue": 123,
"step": 123,
"id": "<string>",
"updatedAt": "<string>",
"uid": "<string>",
"answers": [
{
"createdAt": "<string>",
"uid": "<string>",
"answerValue": 123,
"id": "<string>",
"updatedAt": "<string>",
"text": "<string>",
"goToQuestionUid": "<string>",
"isOther": true
}
],
"isRequired": true,
"skipLogic": true,
"includeOtherOption": true,
"isEnd": true,
"logic": {
"answerUid": "<string>",
"goToQuestionUid": "<string>",
"skipLogicType": {},
"multipleAnswers": [
{
"answer": "<string>",
"logicType": {}
}
],
"multipleAnswersBoolType": {}
},
"order": 123,
"rankRule": {
"topN": 123
},
"randomizeOrder": true,
"matrixRows": [
{
"uid": "<string>",
"text": "<string>",
"qualifyingAnswerUids": [
"<string>"
]
}
],
"warnings": [
"<string>"
]
}
],
"inviteSurveyLink": "<string>",
"closedDetails": {
"closed": true,
"closedMessage": "<string>",
"closedOnDate": "2023-11-07T05:31:56Z",
"closedByUserId": "<string>"
},
"closed": true,
"closedMessage": "<string>",
"closedOnDate": "2023-11-07T05:31:56Z",
"closedByUserId": "<string>",
"ndaDetails": {
"ndaType": "none",
"ndaLink": "<string>",
"ndaFileUrl": "<string>"
},
"ndaType": "none",
"ndaFileUrl": "<string>",
"ndaLink": "<string>",
"filterPastParticipation": {
"hasNeverParticipated": true,
"since": "2023-11-07T05:31:56Z"
},
"seniority": [],
"publishedAt": "2023-11-07T05:31:56Z",
"automations": {
"autopay": true,
"autoinvite": true
},
"keyQualifiers": [],
"advancedTargeting": {
"languages": [],
"numberOfChildren": 1,
"numberOfChildrenLiveAtHome": 1,
"childrenBirthYears": [
"<string>"
],
"pets": [],
"homeOwner": true,
"nationality": [],
"webcam": true,
"mobilePhoneWithInternet": true,
"headsetWithMicrophone": true,
"programmingLanguages": [],
"browsers": [],
"smartphoneOS": [],
"tabletOS": [],
"computerOS": [],
"cloudPlatforms": [],
"codingAITools": [],
"designPrototypingTools": [],
"foodDeliveryServices": [],
"healthWellnessApps": [],
"onlineBankingTools": [],
"onlineLearningPlatforms": [],
"onlineMarketplacePlatforms": [],
"onlineTravelBooking": [],
"productivitySoftware": [],
"smartHomeDevices": [],
"socialNetworkPlatforms": [],
"streamingServices": [],
"vehicleBrands": [],
"employmentStatuses": []
},
"completionUrl": "<string>",
"targetProfessionalIndustries": [
{
"id": "<string>",
"name": "<string>"
}
],
"targetJobTitles": [
{
"id": "<string>",
"name": "<string>"
}
],
"targetProjectTopics": [
{
"id": "<string>",
"name": "<string>"
}
],
"targetAudienceSkills": [
{
"createdAt": "<string>",
"name": "<string>",
"slug": "<string>",
"validated": false,
"type": "skill",
"id": "<string>",
"updatedAt": "<string>",
"count": 0
}
]
}
],
"totalResults": 123
}Query Parameters
Specifies which page of results to return
Number of records to return per page
If true, includes the total count of records
External identifier for the researcher who created project on your system
Current state of the project. See more details on Project Statuses.
Available options:
DRAFT, PAID, ARCHIVED, CLOSED Response
200 - application/json
Hide child attributes
Hide child attributes
Project Title. This is visible to Respondents, do not mention any incentive amount as you may change it during your project.
Internal Project Name. This is visible only to your organization. Character Limit: Min 3 and Max 50.
Available options:
DRAFT, PAID, ARCHIVED, CLOSED Available options:
RECRUITING, RECRUITED, PAUSED Audience type to be targeted for this project. Example values: Industry professionals (B2B) or General Population (B2C)
Available options:
b2b, b2c Research type for this project, if it is in-person or remote
Available options:
inPerson, remote 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]
Available options:
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
Number of Participants We will recruit up to 3 times your target number of qualified participants. Number Limit: Min 1 and Max 500.
Required for all projects to identify your researcher with Respondent to differentiate from other researchers recruiting through your platform.
Hide child attributes
Hide child attributes
A unique researcher ID provided by you, used to associate and filter projects.
To be used when sending messages or emails to the respondent. Full name not required.
Optional additional filtering. This researcher's internal teamId from your organization.
Optional additional filtering. This researcher's internal companyId from your organization.
Link to book a meeting with the researcher. Required if targetResearchMethodology of project is oneOnOne or focusGroup.
Required when publishing a project. This is visible to Respondents. A short description of the project visible to participants. This should clearly outline the purpose, requirements, and expectations for participation. Character Limit: Max 800.
For Unmoderated Studies and Surveys only.
Hide child attributes
Hide child attributes
Custom url for the study, to be sent in the invitation . Can be updated when inviting the participant.
Special instructions for the study, to be sent in the invitation. Can be updated when inviting the participant. Character limit: Max 2000.
Available options:
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 options:
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 Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Available options:
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
Available options:
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 Available options:
selfemployed, 1-10, 11-50, 51-200, 201-500, 501-1000, 1001-5000, 5001-10000, 10000+, all Required for In-Person projects only. Please provide the full address (including city & state if applicable) where the project will be conducted.
Hide child attributes
Hide child attributes
Available options:
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 options:
<30000, 30000-39999, 40000-59999, 60000-79999, 80000-99999, 100000-149999, 150000-199999, 200000+, all, all Available options:
male, female, other, nonbinary, transmale, transfemale, prefernottoanswer, N/A Available options:
somehighschool, highschoolgraduate, somecollegenodegree, tradetechnicalvocationaltraining, associatedegree, bachelordegree, masterdegree, doctoratedegree, N/A Available options:
americanindianalaskannative, hispaniclatino, blackorafricanamerican, asianpacificislander, whitecaucasian, middleeastern, multipleethnicity, prefernotdisclose, N/A Available options:
18-20, 21-29, 30-39, 40-54, 55+, N/A Hide child attributes
Hide child attributes
Available options:
radio, multiLineTextbox, checkbox, singleLineTextbox, numericBox, sliderScale, fileUpload, rank, matrix Hide child attributes
Hide child attributes
CHECKBOX: { id: 3, answerValues: [ { id: 1, text: 'May Select' }, { id: 2, text: 'Must Select' }, { id: 3, text: 'Disqualify' }, ], }, RADIO: { id: 1, answerValues: [ { id: 1, text: 'Qualify' }, { id: 2, text: 'Disqualify' }, ], },
Required unless isOther, then text will be set to 'Other'
Skip logic for radio questions. Uid of question to skip to.
Is 'Other' answer with comment field
Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Cutoff position (1-based). Preferred options must rank within the top N.
Bounded by the per-question option cap; the launch-time schema additionally
enforces topN <= answers.length (which can't be checked here because the
rule is validated independently of the answers array).
Available options:
all, any Available options:
all, any Use projectStatus: 'CLOSED'
Use closedDetails.closedMessage.
Use closedDetails.closedOnDate.
Use closedDetails.closedByUserId.
Use ndaDetails.ndaType.
Available options:
none, file, link Use ndaDetails.ndaFileUrl
Use ndaDetails.ndaLink.
- 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.
Hide child attributes
Hide child attributes
If true → only include participants who have never participated in a project with the researcher.
If false → only include participants who have not participated in a project with the researcher in the past months months.
It's autocalculated based on the hasNeverParticipated / months entered and displays in the API response
Number of months to exclude participants who have previously participated in a study.
Used only when hasNeverParticipated is false. For example, months: 3 excludes participants who participated in the past 3 months.
Available options:
-1, 1, 2, 3, 6, 9, 12 Available options:
unpaid, student, training, entrylevel, senior, manager, director, chiefofficer, partner, vicepresident - 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.
Available options:
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.
Hide child attributes
Hide child attributes
Available options:
single, inRelationship, married, divorced, widowed, separated, domesticPartnershipCivilUnion, itsComplicated, preferNotToSay, other Available options:
en, es, zh, hi, ar, bn, ru, pt, ja, de, fr, it, ko, tr, pl, nl, vi, sv, fa, el, da, fi, no, cs, th, ro, he, id, hu, uk, other Required range:
x >= 0Required range:
x >= 0Available options:
alone, roommates, significantOther, spouse, parents, other Available options:
noPets, dog, cat, bird, fish, reptile, amphibian, other Available options:
american, canadian, mexican, british, french, german, italian, spanish, dutch, swedish, norwegian, danish, finnish, polish, irish, portuguese, greek, swiss, austrian, belgian, czech, romanian, hungarian, chinese, indian, japanese, korean, filipino, vietnamese, thai, malaysian, singaporean, indonesian, pakistani, bangladeshi, australian, newzealander, brazilian, argentinian, colombian, chilean, peruvian, venezuelan, southafrican, nigerian, egyptian, kenyan, israeli, turkish, saudiarabian, other Available options:
urban, suburban, rural Available options:
javaScript, python, java, c#, c++, ruby, php, swift, kotlin, golang, r, typeScript, sql, other Available options:
chrome, edge, firefox, internetExplorer, safari, other Available options:
android, ios, windows, other, noSmartphone Available options:
amazonFire, android, ipadOS, windows, other, noTablet Available options:
macOS, windows, linux, other, noComputer Available options:
aws, microsoftazure, googlecloud, ibmcloud, oraclecloud, alibabacloud, digitalocean, heroku, vercel, netlify, cloudflare, linode, other Available options:
claudecode, cursor, windsurf, githubcopilot, chatgpt, gemini, copilotchat, other Available options:
figma, adobexd, sketch, invision, framer, axure, balsamiq, marvel, protoio, adobephotoshop, adobeillustrator, canva, affinitydesigner, principle, origami, other Available options:
ubereats, doordash, grubhub, postmates, seamless, instacart, deliveroo, justeat, skipthedishes, menulog, foodpanda, zomato, swiggy, rappi, other Available options:
applefitness, fitbit, strava, peloton, niketrainingclub, myfitnesspal, loseit, headspace, calm, insighttimer, tenpercenthappier, betterhelp, talkspace, sleepcycle, slumber, applehealth, googlefit, samsunghealth, noom, weightwatchers, cronometer, other Available options:
chime, varo, current, revolut, n26, monzo, mint, ynab, personalcapital, quicken, paypal, venmo, cashapp, zelle, applepay, googlepay, robinhood, webull, acorns, stash, betterment, wealthfront, coinbase, binance, kraken, other Available options:
coursera, udemy, linkedinlearning, skillshare, edx, khanacademy, pluralsight, masterclass, udacity, datacamp, codecademy, treehouse, brilliant, duolingo, rosettastone, babbel, googleskillshop, other Available options:
amazon, ebay, etsy, walmart, target, bestbuy, alibaba, aliexpress, shopify, wayfair, mercari, poshmark, depop, facebookmarketplace, craigslist, offerup, letgo, other Available options:
expedia, bookingdotcom, airbnb, vrbo, kayak, priceline, hotelsdotcom, tripadvisor, orbitz, travelocity, hotwire, skyscanner, agoda, tripdotcom, hopper, googleflights, other Available options:
microsoftoffice, microsoft365, googleworkspace, appleiwork, notion, evernote, trello, asana, mondaydotcom, slack, microsoftteams, zoom, airtable, clickup, basecamp, jira, confluence, dropbox, googledrive, other Available options:
amazonecho, googlenest, applehomepod, echoshow, nesthub, nestthermostat, ecobee, honeywellhome, philipshue, lifx, nanoleaf, ring, arlo, nestcam, blink, augustlock, tplink, wemo, kasa, roomba, roborock, eufy, smartrefrigerator, smartoven, smartwasher, other Available options:
facebook, instagram, twitter, tiktok, linkedin, snapchat, pinterest, reddit, youtube, whatsapp, telegram, discord, twitch, mastodon, threads, bluesky, wechat, weibo, clubhouse, nextdoor, other Available options:
netflix, amazonprimevideo, disneyplus, hulu, hbomax, appletvplus, paramountplus, peacock, youtubetv, youtubepremium, crunchyroll, discoveryplus, showtime, starz, spotify, applemusic, youtubemusic, amazonmusic, tidal, pandora, soundcloud, slingtv, fubotv, other Available options:
ford, chevrolet, dodge, ram, jeep, gmc, cadillac, tesla, rivian, lucid, toyota, honda, nissan, mazda, subaru, mitsubishi, lexus, acura, infiniti, hyundai, kia, genesis, bmw, mercedesbenz, audi, volkswagen, porsche, volvo, mini, landrover, jaguar, fiat, alfaromeo, peugeot, renault, ferrari, lamborghini, maserati, bentley, rollsroyce, other Available options:
severaltimesweek, aboutonceweek, fewtimesmonth, rarely, never Available options:
neverserved, currentlyserving, veteran Available options:
hybrid, inPerson, remote Available options:
owner, employedfulltime, employedparttime, unemployedlookingforwork, unemployed, retired, homemaker, fulltimestudent, parttimestudent Researchers can provide participants with this link at the conclusion of their survey or study, enabling them to self-report task completion. Available for projects where the targetResearchMethodology is either unmoderatedStudy or survey.
Required for General Population (B2C) projects only Tagging your projects with topics will better help match your general population project with participants that have indicated interest in these topics. Array: Min 1 and Max 2.
Array: Min 0 and Max 25. Select skills, knowledge areas, tools and/or certifications you would like to target.
Hide child attributes
Hide child attributes
The total number of results possible, which is only provided in the response when includeCount is passed as true within a request.
Last modified on March 18, 2026
Was this page helpful?
Previous
Retrieve a specific projectRetrieve full details for a single project, including configuration, targeting criteria, and current status.
Next
⌘I
Retrieve all projects
curl --request GET \
--url https://api-staging.respondent.io/v1/projects \
--header 'x-api-key: <x-api-key>' \
--header 'x-api-secret: <x-api-secret>'import requests
url = "https://api-staging.respondent.io/v1/projects"
headers = {
"x-api-key": "<x-api-key>",
"x-api-secret": "<x-api-secret>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-api-key': '<x-api-key>', 'x-api-secret': '<x-api-secret>'}
};
fetch('https://api-staging.respondent.io/v1/projects', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-staging.respondent.io/v1/projects",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <x-api-key>",
"x-api-secret: <x-api-secret>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-staging.respondent.io/v1/projects"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<x-api-key>")
req.Header.Add("x-api-secret", "<x-api-secret>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-staging.respondent.io/v1/projects")
.header("x-api-key", "<x-api-key>")
.header("x-api-secret", "<x-api-secret>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-staging.respondent.io/v1/projects")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'
request["x-api-secret"] = '<x-api-secret>'
response = http.request(request)
puts response.read_body{
"page": 1,
"pageSize": 50,
"results": [
{
"createdAt": "<string>",
"publicTitle": "<string>",
"publicInternalName": "<string>",
"participantTimeRequiredMinutes": 123,
"incentiveAmount": 123,
"targetNumberOfParticipants": 123,
"externalResearcher": {
"researcherId": "<string>",
"researcherName": "<string>",
"teamId": "<string>",
"companyName": "<string>",
"companyId": "<string>",
"bookingUrl": "<string>"
},
"id": "<string>",
"updatedAt": "<string>",
"publicDescription": "<string>",
"organizationId": "<string>",
"teamId": "<string>",
"unmoderatedStudyOrSurvey": {
"remoteCommunicationDetails": "<string>",
"specialInstructions": "<string>"
},
"targetCountries": [],
"targetCities": [
{
"location": {
"city": "<string>",
"location": {
"longitude": 123,
"latitude": 123
},
"id": "<string>",
"googleId": "<string>",
"region": "<string>",
"state": "<string>",
"zipcode": "<string>",
"address1": "<string>",
"formattedAddress": "<string>"
}
}
],
"targetJobFunctions": [],
"targetCompanySize": [],
"targetLocationRespondentInPerson": {
"address1": "<string>",
"city": "<string>",
"formattedAddress": "<string>",
"latitude": 123,
"longitude": 123,
"id": "<string>",
"zipcode": "<string>",
"region": "<string>",
"state": "<string>"
},
"targetHouseholdIncome": [],
"targetEducation": [],
"targetEthnicities": [],
"targetAgeGroups": [],
"screenerQuestions": [
{
"createdAt": "<string>",
"text": "<string>",
"minValue": 123,
"maxValue": 123,
"step": 123,
"id": "<string>",
"updatedAt": "<string>",
"uid": "<string>",
"answers": [
{
"createdAt": "<string>",
"uid": "<string>",
"answerValue": 123,
"id": "<string>",
"updatedAt": "<string>",
"text": "<string>",
"goToQuestionUid": "<string>",
"isOther": true
}
],
"isRequired": true,
"skipLogic": true,
"includeOtherOption": true,
"isEnd": true,
"logic": {
"answerUid": "<string>",
"goToQuestionUid": "<string>",
"skipLogicType": {},
"multipleAnswers": [
{
"answer": "<string>",
"logicType": {}
}
],
"multipleAnswersBoolType": {}
},
"order": 123,
"rankRule": {
"topN": 123
},
"randomizeOrder": true,
"matrixRows": [
{
"uid": "<string>",
"text": "<string>",
"qualifyingAnswerUids": [
"<string>"
]
}
],
"warnings": [
"<string>"
]
}
],
"inviteSurveyLink": "<string>",
"closedDetails": {
"closed": true,
"closedMessage": "<string>",
"closedOnDate": "2023-11-07T05:31:56Z",
"closedByUserId": "<string>"
},
"closed": true,
"closedMessage": "<string>",
"closedOnDate": "2023-11-07T05:31:56Z",
"closedByUserId": "<string>",
"ndaDetails": {
"ndaType": "none",
"ndaLink": "<string>",
"ndaFileUrl": "<string>"
},
"ndaType": "none",
"ndaFileUrl": "<string>",
"ndaLink": "<string>",
"filterPastParticipation": {
"hasNeverParticipated": true,
"since": "2023-11-07T05:31:56Z"
},
"seniority": [],
"publishedAt": "2023-11-07T05:31:56Z",
"automations": {
"autopay": true,
"autoinvite": true
},
"keyQualifiers": [],
"advancedTargeting": {
"languages": [],
"numberOfChildren": 1,
"numberOfChildrenLiveAtHome": 1,
"childrenBirthYears": [
"<string>"
],
"pets": [],
"homeOwner": true,
"nationality": [],
"webcam": true,
"mobilePhoneWithInternet": true,
"headsetWithMicrophone": true,
"programmingLanguages": [],
"browsers": [],
"smartphoneOS": [],
"tabletOS": [],
"computerOS": [],
"cloudPlatforms": [],
"codingAITools": [],
"designPrototypingTools": [],
"foodDeliveryServices": [],
"healthWellnessApps": [],
"onlineBankingTools": [],
"onlineLearningPlatforms": [],
"onlineMarketplacePlatforms": [],
"onlineTravelBooking": [],
"productivitySoftware": [],
"smartHomeDevices": [],
"socialNetworkPlatforms": [],
"streamingServices": [],
"vehicleBrands": [],
"employmentStatuses": []
},
"completionUrl": "<string>",
"targetProfessionalIndustries": [
{
"id": "<string>",
"name": "<string>"
}
],
"targetJobTitles": [
{
"id": "<string>",
"name": "<string>"
}
],
"targetProjectTopics": [
{
"id": "<string>",
"name": "<string>"
}
],
"targetAudienceSkills": [
{
"createdAt": "<string>",
"name": "<string>",
"slug": "<string>",
"validated": false,
"type": "skill",
"id": "<string>",
"updatedAt": "<string>",
"count": 0
}
]
}
],
"totalResults": 123
}