Get Surveys

GET

/surveys

Surveys

This api call returns the list of all live surveys

Request

Authorization

API Key

Add parameter in header

EQ-PARTNER-ACCESS-KEY

Example:

EQ-PARTNER-ACCESS-KEY: ********************

Header Params

Responses

🟢200OK

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://sandbox-partner-api2.voqall.com/api/v1/surveys' \
--header 'EQ-PARTNER-ACCESS-KEY: <api-key>'

Response Example

{
    "status": "ok",
    "hasError": false,
    "messages": [],
    "error": {
        "errorCode": ""
    },
    "Surveys": [
        {
            "SurveyId": 0,
            "Name": "string",
            "Cpi": "string",
            "Ir": "string",
            "Loi": "string",
            "StudyTypeId": 0,
            "Completes": 0,
            "LanguageId": 0,
            "SurveyUrl": "../dictionary",
            "DesktopAllowed": true,
            "MobileAllowed": true,
            "TabletAllowed": true,
            "LastUpdatedOnUTC": "2019-08-24T14:15:22.123Z",
            "Has_Qualifications": true,
            "Has_Quotas": true,
            "Has_Survey_Groups": true,
            "IndustryId": 0,
            "CollectPii": true,
            "BuyerId": 0,
            "StartDate": "2019-08-24T14:15:22.123Z",
            "EndDate": "2019-08-24T14:15:22.123Z",
            "Qual_LastUpdatedOnUTC": "2019-08-24T14:15:22.123Z",
            "Quota_LastUpdatedOnUTC": "2019-08-24T14:15:22.123Z",
            "Revenue": 0,
            "IncidentRate": 0,
            "LengthOfInterview": 0
        }
    ],
    "SupplierId": 0
}

Surveys

Get Survey Qualifications