Data Partner API
  1. Getting Started
Data Partner API
  • Data Partner API
    • Getting Started
      • Introduction to API
      • Become a Supplier
      • Authentication
      • Urls
    • API Reference
      • Account
        • Get Supplier Details
        • Update redirect urls
        • Update S2S redirect urls
      • Surveys
        • Get Surveys
        • Get Survey Qualifications
        • Get Survey Quotas
        • Get Survey Stats
        • Get Survey Groups
      • Collections
        • Languages
        • Industries
        • StudyTypes
        • SurveyStatuses
        • QualificationCategories
        • QualificationCategoryTypes
        • QualificationTypes
        • Qualifications
        • QualificationDetailById
    • Schemas
      • Survey
      • SupplierAccountResponse
      • SupplierSurveyResponse
      • Qualification
      • SurveyQualificationResponse
      • QuotaCondition
      • SurveyQuotaResponse
      • Quotas
      • SurveyStat
      • SurveyStatsResponse
      • SurveyGroup
      • SurveyGroupsResponse
  1. Getting Started

Authentication

Environments and Base Urls#

The Partner Data API has two environments: Sandbox and Production. Use the following base URLs to access each environment:

Environments#

EnvironmentBase Url
Sandboxhttps://sandbox-partner-api2.voqall.com/api/v1
Productionhttps://partner-api.voqall.com/api/v1
We recommend starting in Sandbox until your integration passes our QA checklist.

Authentication#

The Partner Data API uses API Key for authentication. Include your API Key credentials in the header "EQ-PARTNER-ACCESS-KEY" key of each request.
Example:
curl --location '/api/v1/surveys' \ --header 'EQ-PARTNER-ACCESS-KEY: <API Key>'

Environment Notes#

Please start integration testing in Sandbox
Production credentials and URLs will be shared post-validation
Ensure all parameters are URL-encoded
Previous
Become a Supplier
Next
Urls
Built with