Get Available Surveys (all live surveys)

Sandbox Env

https://supplier-stage.surveysherpa.com

GET

/api/v1/supply/getAvailableSurveys

This API allows suppliers to fetch the list of surveys associated with their account. The response will only include surveys that are currently LIVE.

Request

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://supplier-stage.surveysherpa.com/api/v1/supply/getAvailableSurveys' \
--header 'x-access-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI2NzAzODMwMzY4NWU1OTFjYjkyMGE2MWMiLCJzdXBwbGllcl9pZCI6MjYsImlhdCI6MTcyODI4MzM5NX0.IuaRhVmCrXFIZkSHcgN3Zss8eGGhxd3Q7MkfrAHCYb0'

Responses

🟢200Success

application/json

Body

Example

{
    "apiStatus": "success",
    "msg": "All active assigned surveys are successfully searched",
    "result": [
        {
            "surveyId": 1,
            "survayName": "India",
            "N": 1,
            "CPI": 3,
            "remainingN": 1,
            "LOI": 1,
            "IR": 1,
            "Country": "India",
            "Language": "ENGLISH",
            "reContact": false,
            "surveyLiveURL": "https://www.example.com/screener?survey=z36mXYbQ&supplierId=2&pid=",
            "surveyTestURL": "https://www.example.com/screener?isTest=1&isLive=0&survey=z36mXYbQ&supplierId=2&pid=",
            "projectId": "1",
            "deviceType": "All",
            "projectCategory": "Automotive",
            "createdDate": "2024-09-10T11:21:53.152Z",
            "modifiedDate": "2024-09-10T12:39:41.832Z",
            "PII": false,
            "overAllCompletesAchieved": 0,
            "overAllStartsAchieved": 0,
            "actualIR": "",
            "actualLOI": "",
            "excluded_surveys": [
                2,
                3,
                4
            ],
            "excluded_status": [
                "Client Completes",
                "Client Fails",
                "Client OverQuota",
                "Client Quality Termination"
            ]
        }
    ]
}

Modified at 2025-08-20 05:34:10

Question Library Answer Lookup

Get Available Surveys By Id