Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
version: 1.0.0
title: Kantata OX API Documentation Survey Templates (Legacy) API
description: Kantata OX's API provides access to the majority of Kantata OX's data model.
termsOfService: https://www.kantata.com/terms-of-use
contact:
name: Kantata OX Support
url: https://knowledge.kantata.com/hc/en-us
license:
name: COPYRIGHT © 2026 Kantata, Inc.
url: https://www.kantata.com/terms-of-use
x-logo:
url: https://theme.zdassets.com/theme_assets/56104/04e93064d309f75d054b8cee885d1ea51e9be8f7.png
backgroundColor: '#FFFFFF'
altText: Kantata OX API Documentation
href: https://developer.kantata.com
servers:
- url: https://api.mavenlink.com/api/v1
tags:
- name: Survey Templates (Legacy)
description: 'Survey Templates (Legacy) define a set of questions and defaults from which Survey Responses can be created.
**Note**: This feature requires the Surveys (Legacy) account add-on. This feature is unrelated to Pulse surveys.'
paths:
/survey_templates:
get:
summary: Fetching a list of Survey Templates
description: '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.'
operationId: Get Survey Templates
tags:
- Survey Templates (Legacy)
parameters:
- in: query
name: created_after
description: Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.
schema:
type: string
format: date-time
- in: query
name: created_before
description: Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.
schema:
type: string
format: date-time
- in: query
name: external_reference_external_message
description: Filter the objects based on the external message of their associated external references. This is an exact match.
schema:
type: string
- in: query
name: external_reference_external_status
description: Filter by the status of the external object in the external system.
schema:
type: string
- in: query
name: external_reference_service_model
description: Filter by the type of the external object this external reference belongs to.
schema:
type: string
- in: query
name: external_reference_service_model_ref
description: Filter by the id of the external object this external reference belongs to.
schema:
type: integer
format: int32
- in: query
name: external_reference_service_model_refs
description: Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs.
schema:
type: string
- in: query
name: external_reference_service_name
description: Filter by the name of the provider for integration.
schema:
type: string
- in: query
name: external_reference_status
description: Filter by the status of the integration, this can be successful or fail.
schema:
type: string
- in: query
name: has_external_references
description: Filter by whether or not the object has external references.
schema:
type: boolean
- in: query
name: include
description: '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.'
schema:
type: string
- in: query
name: only
description: '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`.'
schema:
type: string
- in: query
name: order
description: '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`.'
schema:
type: string
default: updated_at:desc
- in: query
name: owner_id
description: Filter results for templates with a particular owner.
schema:
type: integer
format: int32
- in: query
name: page
schema:
type: integer
format: int32
default: 1
- in: query
name: per_page
schema:
type: integer
format: int32
default: 20
maximum: 200
- in: query
name: respondent_id
description: Filter results for templates with a particular respondent.
schema:
type: integer
format: int32
- in: query
name: subject_id
description: 'Filter results for templates with a particular subject. Note: This should always be combined with the subject_type filter.'
schema:
type: integer
format: int32
- in: query
name: subject_type
description: Filter results for templates with a particular subject type.
schema:
type: string
- in: query
name: updated_after
description: Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.
schema:
type: string
format: date-time
- in: query
name: updated_before
description: Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.
schema:
type: string
format: date-time
- in: query
name: without_external_reference_service_name
description: Exclude by the existence of an external reference with the specified service name.
schema:
type: string
- in: query
name: workspace_id
description: Filter results for templates with a particular workspace.
schema:
type: integer
format: int32
responses:
'200':
description: A list of Survey Templates have been retrieved.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
format: int32
meta:
type: object
properties:
count:
type: integer
format: int32
page_count:
type: integer
format: int32
page_number:
type: integer
format: int32
page_size:
type: integer
format: int32
results:
type: array
items:
type: object
properties:
key:
type: string
id:
type: string
survey_templates:
type: object
additionalProperties:
$ref: '#/components/schemas/SurveyTemplate'
external_references:
type: object
additionalProperties:
$ref: '#/components/schemas/ExternalReference'
survey_questions:
type: object
additionalProperties:
$ref: '#/components/schemas/SurveyQuestion'
survey_responses:
type: object
additionalProperties:
$ref: '#/components/schemas/SurveyResponse'
users:
type: object
additionalProperties:
$ref: '#/components/schemas/User'
workspaces:
type: object
additionalProperties:
$ref: '#/components/schemas/Workspace'
stories:
type: object
additionalProperties:
$ref: '#/components/schemas/Story'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'401':
description: Unauthorized request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'403':
description: Forbidden request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'404':
description: Page Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'422':
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'503':
description: Service is unavailable
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
post:
summary: Creating a new Survey Template
description: '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.'
operationId: Create Survey Template
tags:
- Survey Templates (Legacy)
parameters:
- in: query
name: include
description: '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.'
schema:
type: string
responses:
'200':
description: Survey Template has been created.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
format: int32
meta:
type: object
properties:
count:
type: integer
format: int32
page_count:
type: integer
format: int32
page_number:
type: integer
format: int32
page_size:
type: integer
format: int32
results:
type: array
items:
type: object
properties:
key:
type: string
id:
type: string
survey_templates:
type: object
additionalProperties:
$ref: '#/components/schemas/SurveyTemplate'
external_references:
type: object
additionalProperties:
$ref: '#/components/schemas/ExternalReference'
survey_questions:
type: object
additionalProperties:
$ref: '#/components/schemas/SurveyQuestion'
survey_responses:
type: object
additionalProperties:
$ref: '#/components/schemas/SurveyResponse'
users:
type: object
additionalProperties:
$ref: '#/components/schemas/User'
workspaces:
type: object
additionalProperties:
$ref: '#/components/schemas/Workspace'
stories:
type: object
additionalProperties:
$ref: '#/components/schemas/Story'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'401':
description: Unauthorized request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'403':
description: Forbidden request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'404':
description: Page Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'422':
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'503':
description: Service is unavailable
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
requestBody:
content:
application/json:
schema:
type: object
properties:
survey_template:
type: object
properties:
survey_question_ids:
type: array
items:
type: integer
format: int32
description: Survey Questions to associate with this template.
title:
type: string
description: The title of the survey.
description:
type: string
description: The description of the survey.
subject_type:
type: string
description: 'The subject type of the survey. Valid values: User, Story, Workspace.'
subject_id:
type: integer
format: int32
description: The Id of the survey subject.
owner_id:
type: integer
format: int32
description: The user who owns all surveys based on this template.
respondent_id:
type: integer
format: int32
description: The user assigned to respond to surveys based on this template.
workspace_id:
type: integer
format: int32
description: The workspace to be used as context for surveys based on this template.
open_date:
type: string
format: date
description: The open date to be used for surveys based on this template. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.
close_date:
type: string
format: date
description: The close date to be used for surveys based on this template. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.
due_date:
type: string
format: date
description: The due date to be used for surveys based on this template. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.
required:
- survey_question_ids
required: true
/survey_templates/{id}:
put:
summary: Updating an existing Survey Template
description: '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.'
operationId: Update Survey Template
tags:
- Survey Templates (Legacy)
parameters:
- in: path
name: id
required: true
description: The ID of the Model.
schema:
type: integer
- in: query
name: include
description: '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.'
schema:
type: string
responses:
'200':
description: Survey Template has been updated.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
format: int32
meta:
type: object
properties:
count:
type: integer
format: int32
page_count:
type: integer
format: int32
page_number:
type: integer
format: int32
page_size:
type: integer
format: int32
results:
type: array
items:
type: object
properties:
key:
type: string
id:
type: string
survey_templates:
type: object
additionalProperties:
$ref: '#/components/schemas/SurveyTemplate'
external_references:
type: object
additionalProperties:
$ref: '#/components/schemas/ExternalReference'
survey_questions:
type: object
additionalProperties:
$ref: '#/components/schemas/SurveyQuestion'
survey_responses:
type: object
additionalProperties:
$ref: '#/components/schemas/SurveyResponse'
users:
type: object
additionalProperties:
$ref: '#/components/schemas/User'
workspaces:
type: object
additionalProperties:
$ref: '#/components/schemas/Workspace'
stories:
type: object
additionalProperties:
$ref: '#/components/schemas/Story'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'401':
description: Unauthorized request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'403':
description: Forbidden request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'404':
description: Page Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'422':
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'503':
description: Service is unavailable
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
requestBody:
content:
application/json:
schema:
type: object
properties:
survey_template:
type: object
properties:
title:
type: string
description: The title of the survey.
description:
type: string
description: The description of the survey.
owner_id:
type: integer
format: int32
description: The user who owns all surveys based on this template.
open_date:
type: string
format: date
description: The open date for this survey. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.
close_date:
type: string
format: date
description: The close date for this survey. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.
due_date:
type: string
format: date
description: The due date for this survey. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.
required: true
delete:
summary: Deleting an existing Survey Template
description: '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.'
operationId: Delete Survey Template
tags:
- Survey Templates (Legacy)
parameters:
- in: path
name: id
required: true
description: The ID of the Model.
schema:
type: integer
responses:
'204':
description: Survey Template has been deleted.
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'401':
description: Unauthorized request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'403':
description: Forbidden request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'404':
description: Page Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'422':
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'503':
description: Service is unavailable
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
components:
schemas:
ExternalReference:
title: External Reference
description: 'External References allows users see which objects (one of `Assignment`, `BillingMilestone`, `CustomField`, `CustomFieldChoice`, `CustomFieldSet`, `CustomFieldValue`, `Estimate`, `EstimateScenario`, `EstimateScenarioResource`, `Expense`, `ExpenseBudget`, `Invoice`, `Participation`, `Post`, `RateCard`, `Role`, `Skill`, `StatusReport`, `Story`, `StoryAllocationDay`, `Submission`, `SurveyAnswer`, `SurveyQuestion`, `SurveyResponse`, `SurveyTemplate`, `TimeEntry`, `TimeOffEntry`, `User`, `Vendor`, `Workspace`, `WorkspaceAllocation`, `WorkspaceGroup`, or `WorkspaceResource`
are synced with third party systems. This allows you to view the sync status of items in addition to the integration
specifics for a synced object.
Objects that are synced with a third party system have external integration
attributes that include the corresponding ID of the third party object with
which it is synced, a link that allows you to view the object in the third
party system, the status of the external object in the external system,
the status of the sync, and a link to exceptions.'
type: object
properties:
created_at:
type: string
format: date-time
description: The date and time the reference was created.
external_link:
type: string
description: A URL that links to either the external object or event.
external_message:
type: string
description: An optional message about the external object.
external_status:
type: string
description: The status of the external object in the external system.
last_synced_at:
type: string
format: date-time
locked:
type: boolean
description: 'An optional field, indicating whether the subject should be locked. To prevent changes to the
object in Kantata OX, set this to true. This currently only applies to expense report rejections.'
service_model:
type: string
description: The type of the external object to which this reference belongs.
service_model_ref:
type: string
description: The ID of the external object to which this reference belongs.
service_name:
type: string
description: The provider name of the integration.
status:
type: string
description: The status of the integration. Options are 'pending', 'successful', or 'failed'.
subject_id:
type: integer
format: int32
description: The ID of the Kantata OX object to which this external reference belongs.
subject_ref:
type: object
description: '`subject_ref` will only be included in the response if `subject` is in the list of included associations. See <a href=''#section/Includes''>include</a> section for usage.'
properties:
key:
type: string
id:
type: string
subject_type:
type: string
description: 'The type of Kantata OX object to which this external reference belongs.
One of `Assignment`, `BillingMilestone`, `CustomField`, `CustomFieldChoice`, `CustomFieldSet`, `CustomFieldValue`, `Estimate`, `EstimateScenario`, `EstimateScenarioResource`, `Expense`, `ExpenseBudget`, `Invoice`, `Participation`, `Post`, `RateCard`, `Role`, `Skill`, `StatusReport`, `Story`, `StoryAllocationDay`, `Submission`, `SurveyAnswer`, `SurveyQuestion`, `SurveyResponse`, `SurveyTemplate`, `TimeEntry`, `TimeOffEntry`, `User`, `Vendor`, `Workspace`, `WorkspaceAllocation`, `WorkspaceGroup`, or `WorkspaceResource`.'
updated_at:
type: string
format: date-time
description: The date and time the reference was last updated.
Story:
title: Story
description: 'Stories (known as [tasks](https://knowledge.kantata.com/hc/en-us/articles/202806550-Tasks-Overview) in the UI)
are the tasks, deliverables, issues, and milestones required to complete a project.
Stories belong to [Workspaces](/tag/Workspaces), appear in the
[Local Task Tracker](https://knowledge.kantata.com/hc/en-us/articles/202490134-Project-Task-Tracker) and the
[Global Tasks Tracker](https://knowledge.kantata.com/hc/en-us/articles/216424897-Global-Tasks-Tracker),
can be linked to [Posts](/tag/Posts), can have substories (subtasks) and
[Story Tasks](https://developer.kantata.com/tag/Story-Tasks) (checklists), and have many attributes for
planning, organization, and financials.'
type: object
properties:
ancestor_ids:
type: array
items:
type: string
description: The IDs of all the ancestor (i.e. parent) tasks of the task. This is empty for a top-level task.
ancestry_depth:
type: integer
format: int32
description: The number of levels a subtask is nested below the top-level task. Possible values are between `0` (i.e. a top-level task) and `4`.
archived:
type: boolean
description: Whether the task is archived.
archived_editable:
type: boolean
description: 'For archived tasks, whether the authenticated user can edit the task.
Only returned when requested through the optional_fields param.'
assigned_role_id:
type: string
description: '`assigned_role_id` will only be included in the response if `assigned_role` is in the list of included associations. See <a href=''#section/Includes''>include</a> section for usage.'
assignee_ids:
type: array
items:
type: string
description: '`assignee_ids` will only be included in the response if `assignees` is in the list of included associations. See <a href=''#section/Includes''>include</a> section for usage.'
assignment_timestamped_at:
type: string
format: date-time
attachment_ids:
type: array
items:
type: string
description: '`attachment_ids`
# --- truncated at 32 KB (86 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mavenlink/refs/heads/main/openapi/mavenlink-survey-templates-legacy-api-openapi.yml