Skip to content

Survey Answers (Legacy)

Survey Answers (Legacy) appear on and can be responded to through surveys. Survey Answers (Legacy) are required to have a value for the answer (i.e. answers must have at least one choice selected or a non-null value). Additionally, only one value type can be specified for the answer (e.g. specifying a date value as well as choice values is invalid).

Note: This feature requires the Surveys (Legacy) account add-on. This feature is unrelated to Pulse surveys.

Operations

Fetching a list of Survey Answers

Request

This endpoint returns structured Survey Answer 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_answers top-level JSON key. Please see our Response Format section for more information.

Query
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, (int32)

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 selected choices associated with an answer. Only populated on single or multi choice answers.
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • survey_question (SurveyQuestion) - The question that the answer is directed at.
  • survey_response (SurveyResponse) - The response that the answer is tied to.
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.

Default:"updated_at:desc"
pageinteger, (int32)
Default:1
per_pageinteger, (int32), <= 200
Default:20
survey_response_idinteger, (int32)

Filter results by answers for a particular response.

without_external_reference_service_namestring

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

curl -i -X GET \
  'https://api.mavenlink.com/api/v1/survey_answers?external_reference_external_message=string&external_reference_external_status=string&external_reference_service_model=string&external_reference_service_model_ref=0&external_reference_service_model_refs=string&external_reference_service_name=string&external_reference_status=string&has_external_references=true&include=string&only=string&order=updated_at%3Adesc&page=1&per_page=20&survey_response_id=0&without_external_reference_service_name=string'

Responses

A list of Survey Answers have been retrieved.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
survey_answersobject
external_referencesobject
survey_questionsobject
survey_responsesobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "survey_answers": {
    "property1": {
      "choice_ids": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "external_reference_ids": [
        "string"
      ],
      "survey_question_id": "string",
      "survey_response_id": "string",
      "text": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "choice_ids": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "external_reference_ids": [
        "string"
      ],
      "survey_question_id": "string",
      "survey_response_id": "string",
      "text": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "external_references": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "external_link": "string",
      "external_message": "string",
      "external_status": "string",
      "last_synced_at": "2019-08-24T14:15:22Z",
      "locked": true,
      "service_model": "string",
      "service_model_ref": "string",
      "service_name": "string",
      "status": "string",
      "subject_id": 0,
      "subject_ref": {
        "key": "string",
        "id": "string"
      },
      "subject_type": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "external_link": "string",
      "external_message": "string",
      "external_status": "string",
      "last_synced_at": "2019-08-24T14:15:22Z",
      "locked": true,
      "service_model": "string",
      "service_model_ref": "string",
      "service_name": "string",
      "status": "string",
      "subject_id": 0,
      "subject_ref": {
        "key": "string",
        "id": "string"
      },
      "subject_type": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "survey_questions": {
    "property1": {
      "choice_ids": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "external_reference_ids": [
        "string"
      ],
      "question_type": "string",
      "text": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "choice_ids": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "external_reference_ids": [
        "string"
      ],
      "question_type": "string",
      "text": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "survey_responses": {
    "property1": {
      "close_date": "2019-08-24",
      "created_at": "2019-08-24T14:15:22Z",
      "description": "string",
      "due_date": "2019-08-24",
      "external_reference_ids": [
        "string"
      ],
      "open_date": "2019-08-24",
      "owner_id": "string",
      "respondent_id": "string",
      "status": "string",
      "subject_ref": {
        "key": "string",
        "id": "string"
      },
      "survey_answer_ids": [
        "string"
      ],
      "survey_template_id": "string",
      "title": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "workspace_id": "string"
    },
    "property2": {
      "close_date": "2019-08-24",
      "created_at": "2019-08-24T14:15:22Z",
      "description": "string",
      "due_date": "2019-08-24",
      "external_reference_ids": [
        "string"
      ],
      "open_date": "2019-08-24",
      "owner_id": "string",
      "respondent_id": "string",
      "status": "string",
      "subject_ref": {
        "key": "string",
        "id": "string"
      },
      "survey_answer_ids": [
        "string"
      ],
      "survey_template_id": "string",
      "title": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "workspace_id": "string"
    }
  }
}