KAkantata
Survey Questions (Legacy)

Fetching a list of Survey Questions

This endpoint returns structured Survey Question objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the survey_questions top-level JSON key. Please see our Response Format section for more information.

get/survey_questions

Request

  • Base URL
    https://api.mavenlink.com/api/v1
  • Auth
    none declared

Query parameters

external_reference_external_messagestring

Filter the objects based on the external message of their associated external references. This is an exact match.

external_reference_external_statusstring

Filter by the status of the external object in the external system.

external_reference_service_modelstring

Filter by the type of the external object this external reference belongs to.

external_reference_service_model_refinteger

Filter by the id of the external object this external reference belongs to.

external_reference_service_model_refsstring

Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs.

external_reference_service_namestring

Filter by the name of the provider for integration.

external_reference_statusstring

Filter by the status of the integration, this can be successful or fail.

has_external_referencesboolean

Filter by whether or not the object has external references.

includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • choices (SurveyQuestionChoice) - The available choices associated with a question. Only populated on single or multi choice questions.
  • external_references (ExternalReference) - Includes references to external integrations for this object.
included_on_templateinteger

Filter results for questions included on a particular template.

onlystring

Allows you to request one or more resources directly by ID. Multiple IDs can be supplied in a comma separated list, like GET /api/v1/workspaces.json?only=5,6,7.

orderstring

Supply order with the name of a valid sort field for the endpoint and a direction.

Valid values: created_at:asc, created_at:desc, updated_at:asc, and updated_at:desc.

pageinteger
per_pageinteger
without_external_reference_service_namestring

Exclude by the existence of an external reference with the specified service name.

Response

A list of Survey Questions have been retrieved.

countinteger
survey_questionsobject
external_referencesobject

Changes

No recorded changes to this operation across all 1 revision of this API.