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

Task Status Sets

Task Status Sets allow you to create custom statuses for tasks (stories) that can then be applied to projects.

Fetching a list of Task Status Sets

Gets a list of task status sets on the account. To include information in the response about the statuses within the sets, add ?include=custom_task_statuses to the request.

This endpoint returns structured Task Status Set 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 task_status_sets 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.

  • custom_task_statuses (StatusSetOption) - Retrieves all of the statuses within this status set. The response will include custom_task_status_ids, which references the data in the custom_task_statuses top-level key.
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.

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

A list of Task Status Sets have been retrieved.

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

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/task_status_sets
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "task_status_sets": {
    },
  • "custom_task_statuses": {
    }
}
Creating a new Task Status Set
Creates a task status set on the account that contains only the four default statuses (e.g. custom_task_statuses)—not started, started, needs info, and completed.


This endpoint returns structured Task Status Set 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 task_status_sets 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.


    

  • custom_task_statuses (StatusSetOption) - Retrieves all of the statuses within this status set. The response will include custom_task_status_ids, which references the data in the custom_task_statuses top-level key.
    • 



 
Request Body schema: application/json
required
object
 
name
required
string
The name of the task status set.


 
Responses 
200
Task Status Set has been created.


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


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


post/task_status_sets
Request samples 
application/json
{
  • "task_status_set": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "task_status_sets": {
    },
  • "custom_task_statuses": {
    }
}
Fetching a single Task Status Set
Gets a task status set on the account. To include information in the response about the statuses within the set, add ?include=custom_task_statuses to the request.


This endpoint returns structured Task Status Set 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 task_status_sets 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.


    

  • custom_task_statuses (StatusSetOption) - Retrieves all of the statuses within this status set. The response will include custom_task_status_ids, which references the data in the custom_task_statuses top-level key.
    • 



 
Responses 
200
The Task Status Set has been retrieved.


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


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


get/task_status_sets/{id}
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "task_status_sets": {
    },
  • "custom_task_statuses": {
    }
}
Updating an existing Task Status Set
Updates a task status set. Only the name can be updated with this endpoint. To update the statuses available in the set, use the Custom Task Statuses API instead. To change which set is the account default, use the Set Account Default Task Status Set endpoint instead.


This endpoint returns structured Task Status Set 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 task_status_sets 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.


    

  • custom_task_statuses (StatusSetOption) - Retrieves all of the statuses within this status set. The response will include custom_task_status_ids, which references the data in the custom_task_statuses top-level key.
    • 



 
Request Body schema: application/json
required
object
 
name
required
string
The name of the task status set.


 
Responses 
200
Task Status Set has been updated.


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


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


put/task_status_sets/{id}
Request samples 
application/json
{
  • "task_status_set": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "task_status_sets": {
    },
  • "custom_task_statuses": {
    }
}
Deleting an existing Task Status Set
Deletes a task status set and the statuses within the set. Only task status sets that are not in use can be deleted.


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
Task Status Set has been deleted.


400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


delete/task_status_sets/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
Update Account Default Task Status Set
Designates a task status set as the default set to be applied to new projects.


This endpoint returns structured Task Status Set 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 task_status_sets 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.


    

  • custom_task_statuses (StatusSetOption) - Retrieves all of the statuses within this status set. The response will include custom_task_status_ids, which references the data in the custom_task_statuses top-level key.
    • 



 
Responses 
200
Task Status Set has been updated.


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


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


put/task_status_sets/{id}/update_account_default
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "task_status_sets": {
    },
  • "custom_task_statuses": {
    }
}
➔ Next to Task Statuses