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>'
{
  "totalResults": 123,
  "page": 1,
  "pageSize": 50,
  "results": [
    {
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "publicTitle": "<string>",
      "publicInternalName": "<string>",
      "publicDescription": "<string>",
      "organizationId": "<string>",
      "teamId": "<string>",
      "projectStatus": "DRAFT",
      "projectRecruitingStatus": "RECRUITING",
      "targetMarketType": "b2b",
      "typeOfResearch": "inPerson",
      "targetResearchMethodology": "oneOnOne",
      "unmoderatedStudyOrSurvey": {
        "remoteCommunicationDetails": "<string>",
        "specialInstructions": "<string>"
      },
      "participantTimeRequiredMinutes": 123,
      "incentiveAmount": 123,
      "targetNumberOfParticipants": 123,
      "targetCountry": "AX",
      "targetCountries": [
        "AX"
      ],
      "targetCities": [
        {
          "location": {
            "id": "<string>",
            "googleId": "<string>",
            "region": "<string>",
            "city": "<string>",
            "state": "<string>",
            "country": "AX",
            "zipcode": "<string>",
            "address1": "<string>",
            "formattedAddress": "<string>",
            "location": {
              "longitude": 123,
              "latitude": 123
            }
          }
        }
      ],
      "targetJobFunctions": [
        "accountingAuditing"
      ],
      "targetCompanySize": [
        "selfemployed"
      ],
      "targetLocationRespondentInPerson": {
        "id": "<string>",
        "address1": "<string>",
        "zipcode": "<string>",
        "city": "<string>",
        "region": "<string>",
        "state": "<string>",
        "country": "AX",
        "formattedAddress": "<string>",
        "latitude": 123,
        "longitude": 123
      },
      "targetHouseholdIncome": [
        "<30000"
      ],
      "targetGenders": "male",
      "targetEducation": [
        "somehighschool"
      ],
      "targetEthnicities": [
        "americanindianalaskannative"
      ],
      "targetAgeGroups": [
        "18-20"
      ],
      "screenerQuestions": [
        {
          "createdAt": "<string>",
          "updatedAt": "<string>",
          "questionType": "radio",
          "uid": "<string>",
          "text": "<string>",
          "answers": [
            {
              "createdAt": "<string>",
              "updatedAt": "<string>",
              "uid": "<string>",
              "text": "<string>",
              "answerValue": 123,
              "goToQuestionUid": "<string>",
              "isOther": true,
              "id": "<string>"
            }
          ],
          "isRequired": true,
          "skipLogic": true,
          "includeOtherOption": true,
          "isEnd": true,
          "logic": {
            "answerUid": "<string>",
            "goToQuestionUid": "<string>",
            "skipLogicType": {
              "id": 1,
              "text": "Selected"
            },
            "multipleAnswers": [
              {
                "answer": "<string>",
                "logicType": {
                  "id": 1,
                  "text": "Selected"
                }
              }
            ],
            "multipleAnswersBoolType": {
              "id": 1,
              "text": "AND"
            }
          },
          "minValue": 123,
          "maxValue": 123,
          "step": 123,
          "order": 123,
          "warnings": [
            "<string>"
          ],
          "id": "<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",
        "months": "-1"
      },
      "externalResearcher": {
        "researcherId": "<string>",
        "researcherName": "<string>",
        "teamId": "<string>",
        "companyName": "<string>",
        "companyId": "<string>",
        "bookingUrl": "<string>"
      },
      "seniority": [
        "unpaid"
      ],
      "publishedAt": "2023-11-07T05:31:56Z",
      "automations": {
        "autopay": true,
        "autoinvite": true
      },
      "keyQualifiers": [
        "targetHouseholdIncome"
      ],
      "completionUrl": "<string>",
      "targetProfessionalIndustries": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "targetJobTitles": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "targetProjectTopics": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "targetAudienceSkills": [
        {
          "createdAt": "<string>",
          "updatedAt": "<string>",
          "name": "<string>",
          "slug": "<string>",
          "validated": false,
          "type": "skill",
          "count": 0,
          "id": "<string>"
        }
      ],
      "id": "<string>"
    }
  ]
}

Headers

x-api-key
string
required
x-api-secret
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

externalResearcherId
string

External identifier for the researcher who created project on your system

status
enum<string>

Current state of the project. See more details on Project Statuses.

Available options:
DRAFT,
PAID,
ARCHIVED,
CLOSED

Response

200 - application/json

The response is of type object.