surveys

List surveys

This endpoint allows the client to retrieve a list of surveys.

It supports pagination and optional filtering by active status.

Internal only. Admin authorization is required to access this endpoint.

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.

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

created_atstring date-time required

updated_atstring date-time required