Kantata Kantata OX Knowledge Base
Release Notes
Kantata OX Release Notes API Breaking Changes
Status Page
Kantata OX API Documentation

Survey Templates

Survey Templates define a set of questions and defaults from which SurveyResponses can be created. This feature requires the Surveys account add-on.

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.

Request
query Parameters
created_after
string <date-time>

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

created_before
string <date-time>

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

external_reference_external_message
string

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

external_reference_external_status
string

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

external_reference_service_model
string

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

external_reference_service_model_ref
integer <int32>

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

external_reference_service_model_refs
string

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_name
string

Filter by the name of the provider for integration.

external_reference_status
string

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

has_external_references
boolean

Filter by whether or not the object has external references.

include
string

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.
only
string

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.

order
string
Default: "updated_at:desc"

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_id
integer <int32>

Filter results for templates with a particular owner.

page
integer <int32>
Default: 1
per_page
integer <int32> <= 200
Default: 20
respondent_id
integer <int32>

Filter results for templates with a particular respondent.

subject_id
integer <int32>

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

subject_type
string

Filter results for templates with a particular subject type.

updated_after
string <date-time>

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

updated_before
string <date-time>

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

without_external_reference_service_name
string

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

workspace_id
integer <int32>

Filter results for templates with a particular workspace.

Responses
200

A list of Survey Templates have been retrieved.

Response Schema: application/json
count
integer <int32>
object
Array of objects
object
object
object
object
object
object
400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/survey_templates
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "survey_templates": {
    },
  • "external_references": {
    },
  • "survey_questions": {
    },
  • "survey_responses": {
    },
  • "users": {
    },
  • "workspaces": {
    }
}
Creating a new Survey Template
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.


Request 
query Parameters
include
string
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.
    • 



 
Request Body schema: application/json
required
object
 
survey_question_ids
required
Array of integers <int32> 
Survey Questions to associate with this template.


 
title
string
The title of the survey.


 
description
string
The description of the survey.


 
subject_type
string
The subject type of the survey. Valid values: User, Story, Workspace.


 
subject_id
integer <int32> 
The Id of the survey subject.


 
owner_id
integer <int32> 
The user who owns all surveys based on this template.


 
respondent_id
integer <int32> 
The user assigned to respond to surveys based on this template.


 
workspace_id
integer <int32> 
The workspace to be used as context for surveys based on this template.


 
open_date
string <date> 
The open date to be used for surveys based on this template. The date must be in ISO 8601 format.


 
close_date
string <date> 
The close date to be used for surveys based on this template. The date must be in ISO 8601 format.


 
due_date
string <date> 
The due date to be used for surveys based on this template. The date must be in ISO 8601 format.


 
Responses 
200
Survey Template has been created.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
object
 
object
 
object
 
object
 
object
 
object
 
400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


post/survey_templates
Request samples 
application/json
{
  • "survey_template": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "survey_templates": {
    },
  • "external_references": {
    },
  • "survey_questions": {
    },
  • "survey_responses": {
    },
  • "users": {
    },
  • "workspaces": {
    }
}
Updating an existing Survey Template
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.


Request 
path Parameters
id
required
integer
The ID of the Model.


 
query Parameters
include
string
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.
    • 



 
Request Body schema: application/json
required
object
 
title
string
The title of the survey.


 
description
string
The description of the survey.


 
owner_id
integer <int32> 
The user who owns all surveys based on this template.


 
open_date
string <date> 
The open date for this survey. The date must be in ISO 8601 format.


 
close_date
string <date> 
The close date for this survey. The date must be in ISO 8601 format.


 
due_date
string <date> 
The due date for this survey. The date must be in ISO 8601 format.


 
Responses 
200
Survey Template has been updated.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
object
 
object
 
object
 
object
 
object
 
object
 
400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


put/survey_templates/{id}
Request samples 
application/json
{
  • "survey_template": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "survey_templates": {
    },
  • "external_references": {
    },
  • "survey_questions": {
    },
  • "survey_responses": {
    },
  • "users": {
    },
  • "workspaces": {
    }
}
Deleting an existing Survey Template
The response will contain no content and an HTTP 204 status code if the request was
successful, or a standard Kantata OX error message explaining why the object could not be deleted.


Request 
path Parameters
id
required
integer
The ID of the Model.


 
Responses 
204
Survey Template has been deleted.


400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


delete/survey_templates/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to Assignments