Skip to content

Task Status Sets

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

Operations

Fetching a list of Task Status Sets

Request

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.

Query
includestring

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

pageinteger, (int32)
Default:1
per_pageinteger, (int32), <= 200
Default:20
GET
/task_status_sets
curl -i -X GET \
  'https://api.mavenlink.com/api/v1/task_status_sets?include=string&only=string&page=1&per_page=20'

Responses

A list of Task Status Sets have been retrieved.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
task_status_setsobject
custom_task_statusesobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "task_status_sets": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "custom_task_status_ids": [
        "string"
      ],
      "name": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "custom_task_status_ids": [
        "string"
      ],
      "name": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "custom_task_statuses": {
    "property1": {
      "category": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "position": 0,
      "status": "string",
      "status_set_id": 0,
      "task_status_set_id": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "category": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "position": 0,
      "status": "string",
      "status_set_id": 0,
      "task_status_set_id": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  }
}