Sign in

v52

latestOpenAPI 3.0.3raw.githubusercontent.com2026-07-2113138232.4 KB
surveys

List surveys

Retrieve a list of surveys configured on the platform.

Surveys Overview:

  • Surveys are admin-defined questionnaires consisting of multiple choice or text polls.
  • Requires Administrator authorization.
  • Supports standard pagination controls and active status filtering.
get/api/surveys

Query parameters

pageinteger

Pagination page

per_pageinteger

Page size (the number of items to return per page). The default maximum value can be overridden by "API_PER_PAGE_MAX" environment variable.

activeboolean

Filter by active status. Omit to return all surveys.

Response

A list of surveys

type_of'survey' required

Resource discriminator

idinteger required
titlestring required
slugstring required
survey_type_of'community_pulse' | 'industry' | 'fun' required

Survey category

activeboolean nullable

Whether the survey is currently active

display_titleboolean required

Whether to show the title to respondents

allow_resubmissionboolean required

Whether users can submit multiple times

daily_email_distributionsinteger

Daily email distributions count

extra_email_context_paragraphstring nullable

Optional context paragraph for emails

target_response_countinteger

Target response count

target_completion_datestring date-time nullable

Target completion date in the future

created_atstring date-time required
updated_atstring date-time required