Skip to main content
​
GET /surveys field coverage

​
Survey list fields, fielding stats, and COMPLETE API flag

Documentation aligned with the live GET /surveys response.

​
Surveys

  • Documented completes_check_enabled on survey_attributes (COMPLETE API server-side complete validation; optional on create, defaults to the account setting)
  • Documented nested field_details fields returned on GET /surveys: inflight, abandons, defender_terminates, reconciliation counts/costs (accepted_completes, accepted_unregistered_completes, rejected_completes, accepted_cost, accepted_unregistered_cost, rejected_cost, final_cost, final_completes)
  • Documented the list envelope: total_surveys, page, page_size, surveys
  • Added Scheduled and Auto-Paused to documented survey statuses
​
Respondent status codes

​
Respondent Status Codes

Added a Respondent Status Codes reference covering:
  • Client redirect inbound_code values (1000, 2000, 3000, 4000, and quality 1)
  • How GET /responses maps codes to named statuses
  • Full isc sub-codes, including Research Desk terms, over-quotas, and Defender outcomes
​
Auth, qualifications, survey test links

​
WorkOS AuthKit, English qualifications text, and Desk RX test links

Documentation aligned with recent Demand API deployments.

​
Authentication

  • Authorized requests accept WorkOS AuthKit access tokens in the Authorization header, in addition to Cognito JWTs from POST /tokens
  • POST /tokens remains Cognito email/password token issuance only

​
Qualifications (GET /qualifications)

  • Added english_only — when present, returns English question/option text
  • Added globals — when present, includes global_id and global_name
  • Corrected name filter parameter to names (comma-delimited)
  • Documented page default as 1; country_code and language_code required

​
Surveys

  • Documented system-assigned desk_test_link (Test Link) and desk_rx_test_link (Live/RX Test Link) on survey responses
​
v1.1

​
Research Desk Demand API v1.1

Initial public release of the Research Desk Demand API. Provides programmatic access to the full survey lifecycle — from project creation and audience targeting through fieldwork management and respondent reconciliation.

​
Endpoint Groups

Authentication
  • POST /tokens — Generate a JWT token using email and password credentials
Account Management
  • GET /users — Retrieve users associated with your account
  • GET /accounts — Retrieve account details and configuration
Lookups
  • GET /definitions — Fetch platform-wide reference values (countries, languages, survey statuses, etc.)
  • GET /qualifications — Retrieve the full library of audience targeting attributes and their valid option values
Projects
  • GET /projects — List and filter projects
  • POST /projects — Create a new project
  • PATCH /projects/{id} — Update project details or status
Surveys
  • GET /surveys — List and filter surveys within a project
  • POST /surveys — Create a new survey with targeting, quotas, and redirect links
  • PATCH /surveys/{id} — Update survey configuration, status, or compensation
Responses
  • GET /responses — Retrieve respondent records with status and metadata
  • PATCH /responses/{id} — Reconcile individual response records (quality-based exclusions)