Mavenlink Task Statuses API
Custom task statuses can be created to be used on tasks (stories). Custom task statuses are associated to task status sets, which can be applied to projects (workspaces).
Custom task statuses can be created to be used on tasks (stories). Custom task statuses are associated to task status sets, which can be applied to projects (workspaces).
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/mavenlink:mavenlink-task-statuses-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
version: 1.0.0
title: Kantata OX API Documentation Task Statuses 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: Task Statuses
description: Custom task statuses can be created to be used on tasks (stories). Custom task statuses are associated to task status sets, which can be applied to projects (workspaces).
paths:
/custom_task_statuses:
get:
summary: Fetching a list of Custom Task Statuses
description: 'This endpoint returns structured Custom Task Status 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 `custom_task_statuses` top-level JSON key.
Please see our Response Format section for more information.'
operationId: GetCustomTaskStatuses
tags:
- Task Statuses
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`.
- `task_status_set` (StatusSet) - Retrieves the task status set the custom status is in. The response will include `task_status_set_id`, which references the data in the `task_status_sets` top-level key.'
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: page
schema:
type: integer
format: int32
default: 1
- in: query
name: per_page
schema:
type: integer
format: int32
default: 20
maximum: 200
responses:
'200':
description: A list of Custom Task Statuses 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
custom_task_statuses:
type: object
additionalProperties:
$ref: '#/components/schemas/StatusSetOption'
task_status_sets:
type: object
additionalProperties:
$ref: '#/components/schemas/StatusSet'
'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'
x-operation-id-source: normalized
x-operation-id-original: Get Custom Task Statuses
post:
summary: Creating a new Custom Task Status
description: 'Adds a new custom status to a task status set.
This endpoint returns structured Custom Task Status 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 `custom_task_statuses` top-level JSON key.
Please see our Response Format section for more information.'
operationId: CreateCustomTaskStatus
tags:
- Task Statuses
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`.
- `task_status_set` (StatusSet) - Retrieves the task status set the custom status is in. The response will include `task_status_set_id`, which references the data in the `task_status_sets` top-level key.'
schema:
type: string
responses:
'200':
description: Custom Task Status 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
custom_task_statuses:
type: object
additionalProperties:
$ref: '#/components/schemas/StatusSetOption'
task_status_sets:
type: object
additionalProperties:
$ref: '#/components/schemas/StatusSet'
'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:
custom_task_status:
type: object
properties:
status:
type: string
description: The name of the custom task status. The name must be unique within the set.
category:
type: string
description: The category (i.e. status type) for this custom status. Possible values are `not started`, `started`, `needs info`, or `completed`.
status_set_id:
type: integer
format: int32
description: The ID of the task status set to add the custom status to.
required:
- status
- category
- status_set_id
required: true
x-operation-id-source: normalized
x-operation-id-original: Create Custom Task Status
/custom_task_statuses/{id}:
get:
summary: Fetching a single Custom Task Status
description: 'This endpoint returns structured Custom Task Status 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 `custom_task_statuses` top-level JSON key.
Please see our Response Format section for more information.'
operationId: GetCustomTaskStatus
tags:
- Task Statuses
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`.
- `task_status_set` (StatusSet) - Retrieves the task status set the custom status is in. The response will include `task_status_set_id`, which references the data in the `task_status_sets` top-level key.'
schema:
type: string
responses:
'200':
description: The Custom Task Status has 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
custom_task_statuses:
type: object
additionalProperties:
$ref: '#/components/schemas/StatusSetOption'
task_status_sets:
type: object
additionalProperties:
$ref: '#/components/schemas/StatusSet'
'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'
x-operation-id-source: normalized
x-operation-id-original: Get Custom Task Status
put:
summary: Updating an existing Custom Task Status
description: 'Updates a custom task status. The name and position in the task status set can be updated. The status cannot be moved to a different status set and the category cannot be changed.
This endpoint returns structured Custom Task Status 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 `custom_task_statuses` top-level JSON key.
Please see our Response Format section for more information.'
operationId: UpdateCustomTaskStatus
tags:
- Task Statuses
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`.
- `task_status_set` (StatusSet) - Retrieves the task status set the custom status is in. The response will include `task_status_set_id`, which references the data in the `task_status_sets` top-level key.'
schema:
type: string
responses:
'200':
description: Custom Task Status 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
custom_task_statuses:
type: object
additionalProperties:
$ref: '#/components/schemas/StatusSetOption'
task_status_sets:
type: object
additionalProperties:
$ref: '#/components/schemas/StatusSet'
'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:
custom_task_status:
type: object
properties:
status:
type: string
description: The name of the custom task status. The name must be unique within the set.
position:
type: integer
format: int32
description: The order to place the custom task status within the set.
required: true
x-operation-id-source: normalized
x-operation-id-original: Update Custom Task Status
delete:
summary: Deleting an existing Custom Task Status
description: 'Deletes a custom task status within a task status set. If assigned to a task (story), the task’s `status` will default to the status type (category)—`not started`, `started`, `needs info`, or `completed`.
- This will delete the task status from this set. If this status is currently being used by a task in a project, the status will reset to its default status type: Not Started, Started, Needs Info, or Completed.
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: DeleteCustomTaskStatus
tags:
- Task Statuses
parameters:
- in: path
name: id
required: true
description: The ID of the Model.
schema:
type: integer
responses:
'204':
description: Custom Task Status 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'
x-operation-id-source: normalized
x-operation-id-original: Delete Custom Task Status
components:
schemas:
Errors:
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/Error'
Error:
type: object
properties:
type:
type: string
message:
type: string
StatusSetOption:
title: Custom Task Status
description: A custom task status is in a Task Status Set. A task status set is assigned to a workspace (project), then custom task statuses can be applied to the stories (tasks) within the workspace.
type: object
properties:
category:
type: string
description: The type of the status. Possible values are `not started`, `started`, `needs info`, or `completed`.
created_at:
type: string
format: date-time
position:
type: integer
format: int32
description: The position of this status within the task status set.
status:
type: string
description: The name of the custom task status.
status_set_id:
type: integer
format: int32
description: The ID of the task status set that this status is within.
task_status_set_id:
type: string
description: '`task_status_set_id` will only be included in the response if `task_status_set` is in the list of included associations. See <a href=''#section/Includes''>include</a> section for usage.'
updated_at:
type: string
format: date-time
StatusSet:
title: Task Status Set
description: Task Status Sets allow you to create custom statuses for tasks (stories) that can then be applied to projects (workspaces).
type: object
properties:
created_at:
type: string
format: date-time
custom_task_status_ids:
type: array
items:
type: string
description: '`custom_task_status_ids` will only be included in the response if `custom_task_statuses` is in the list of included associations. See <a href=''#section/Includes''>include</a> section for usage.'
name:
type: string
description: The name of this status set.
updated_at:
type: string
format: date-time
securitySchemes:
BearerToken:
type: apiKey
name: Bearer
in: header
OauthSecurity:
type: oauth2
flows:
authorizationCode:
scopes: {}
authorizationUrl: https://app.mavenlink.com/oauth/authorize
tokenUrl: https://app.mavenlink.com/oauth/token
x-tagGroups:
- name: '# Subscribed Events'
tags:
- Event Types
- Events
- name: Account Locations
tags:
- Account Locations
- name: Account Settings & Members
tags:
- Access Group Memberships
- Account Colors
- Account Invitations
- Account Memberships
- Backup Approver Associations
- Billable Utilizations
- Cost Rates
- Custom Branding
- Organization Memberships
- Organizations
- Roles
- Skill Categories
- Skill Memberships
- Skills
- Task Status Sets
- Task Statuses
- User Group Memberships
- Users
- name: Currencies
tags:
- Currencies
- name: Custom Fields
tags:
- Custom Field Choices
- Custom Field Sets
- Custom Field Values
- Custom Fields
- name: Data Exporter
tags:
- Data Export Schema
- Data Exports
- name: Estimates
tags:
- Estimate Scenario Resource Allocations
- Estimate Scenario Resources
- Estimate Scenarios
- Estimates
- name: Expense Budgets
tags:
- Expense Budgets
- name: Expense Tracking
tags:
- Attachments
- Expense Categories
- Expense Report Submissions
- Expenses
- Vendors
- name: External References
tags:
- External References
- name: Financials
tags:
- Billing Milestones
- Revenue Recognition Methods
- name: Foreign Exchange
tags:
- Exchange Tables
- name: Insights & Analytics
tags:
- Insights Access Group Memberships
- Insights Dynamic Dashboards
- Insights Report Exports
- Insights Reports
- name: Invoices
tags:
- Client Invoice Defaults
- External Payments
- Invoices
- Workspace Invoice Preferences
- name: Personal Settings
tags:
- Users
- name: Posts & Replies
tags:
- Attachments
- Posts
- User File Associations
- name: Project Snapshots
tags:
- Project Snapshots
- name: Project Templates
tags:
- Project Template Additional Tabs
- Project Template Assignments
- Project Template Expense Budgets
- Project Templates
- name: Projects
tags:
- Participations
- Project Accounting Records
- Status Reports
- Workspace Allocations
- Workspace Baselines
- Workspace Groups
- Workspace Invoice Preferences
- Workspace Resource Skills
- Workspace Resources
- Workspace Status Changes
- Workspace Task Status Sets
- Workspaces
- name: Rate Cards
tags:
- Activations
- Rate Card Role (Rate for a Role)
- Rate Card Set Version (Effective version by Date)
- Rate Card Sets (Group of Rate Cards)
- Rate Card Table Rows
- Rate Card Versions
- Rate Cards (Multiple Currencies)
- name: Recommendations
tags:
- Recommendations
- name: Resource Requests
tags:
- Resource Requests
- name: Scheduling
tags:
- Holiday Calendar Associations
- Holiday Calendar Memberships
- Holiday Calendars
- Holidays
- Time Off Entries
- Workweek Memberships
- Workweeks
- name: Surveys (Legacy)
tags:
- Survey Answers (Legacy)
- Survey Questions (Legacy)
- Survey Templates (Legacy)
- Surveys Responses (Legacy)
- name: Tasks
tags:
- Assignments
- Daily Scheduled Hours (Story Allocation Days)
- Followers
- Stories
- Story Dependencies
- Story State Changes
- Story Tasks
- name: Time Tracking
tags:
- Line Item Locks
- Time Entries
- Timesheet Approvals
- Timesheet Cancellations
- Timesheet Rejections
- Timesheet Submissions