KAkantata
Survey Templates (Legacy)

Fetching a list of Survey Templates

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

get/survey_templates

Request

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

Query parameters

created_afterstring date-time

Filter for records created after a specified datetime. The datetime must be in ISO 8601 format.

created_beforestring date-time

Filter for records created before a specified datetime. The datetime must be in ISO 8601 format.

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.

  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • owner (User) - The user who owns all surveys based on this template.
  • respondent (User) - The user assigned to respond to surveys based on this template.
  • subject (polymorphic) - The subject of the survey (e.g. the user being reviewed).
  • survey_questions (SurveyQuestion) - Includes survey questions associated with the survey template.
  • survey_responses (SurveyResponse) - Includes the survey responses associated with the survey template.
  • workspace (Workspace) - The workspace to be used as context for surveys based on this 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.

owner_idinteger

Filter results for templates with a particular owner.

pageinteger
per_pageinteger
respondent_idinteger

Filter results for templates with a particular respondent.

subject_idinteger

Filter results for templates with a particular subject. Note: This should always be combined with the subject_type filter.

subject_typestring

Filter results for templates with a particular subject type.

updated_afterstring date-time

Filter for records updated after a specified datetime. The datetime must be in ISO 8601 format.

updated_beforestring date-time

Filter for records updated before a specified datetime. The datetime must be in ISO 8601 format.

without_external_reference_service_namestring

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

workspace_idinteger

Filter results for templates with a particular workspace.

Response

A list of Survey Templates have been retrieved.

countinteger
survey_templatesobject
external_referencesobject
survey_questionsobject
survey_responsesobject
usersobject
workspacesobject
storiesobject

Changes

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