Skip to main content
GET
Surveys
Rate limit: 10 requests/second Note: The GET method returns a list of objects, POST and PATCH accept and return a single object
Query String Parameters (GET)
Survey Object Definition
List Response (GET)
Field Details Object (field_details)
Returned on GET /surveys. Counts and costs default to 0; actual length of interview and incidence rate are null until completes exist.

Authorizations

Authorization
string
header
required

JWT access token sent directly in the Authorization header (no Bearer prefix). Accepted tokens: (1) Cognito JWT from POST /tokens, or (2) WorkOS AuthKit access token issued for your Research Desk organization. POST /tokens still issues Cognito tokens only.

Query Parameters

ids
string

Comma-delimited list of Survey IDs to retrieve.

project_ids
string

Comma-delimited list of Project IDs to filter surveys by.

statuses
string

Comma-delimited list of survey statuses to filter by.

fields
string

Comma-delimited list of field names to include in the response.

page
integer

Page number to retrieve. Defaults to 1.

page_size
integer

Number of results per page. Defaults to 50.

Response

200 - application/json

Surveys

total_surveys
integer

Total number of surveys matching the query across all pages.

page
integer

Current page number.

page_size
integer

Number of surveys returned on this page.

surveys
object[]