FOforem
surveys

A survey with polls

Changed on

Retrieve a single survey (by ID or slug) with its nested structure.

Nested Format Details:

  • Returns the target Survey object including all associated Polls, multiple choice options, and configuration states.
  • Requires Administrator authorization.
get/api/surveys/{id_or_slug}

Request

  • Base URL
    https://dev.to
  • Auth
    • API key in header api-key
    • or HTTP bearer

Path parameters

id_or_slugstring required

The ID or slug of the survey.

Response

A survey with nested polls and options

type_of'survey' required

Resource discriminator

idinteger required
titlestring required
slugstring required
survey_type_of'community_pulse' | 'industry' | 'fun' | 'beta_testing' 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

Changes

  • v18b9d46508069Revision changes
    • warning

      added the new beta_testing enum value to the //// response property for the response status

  • v1ffddb865fa73Revision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status