Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
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.
All 92 tools →
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/mavenlink-assignments-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API 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. 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 Assignments 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: Assignments
description: 'The Assignments object allows you to view and manage task assignments for
named or unnamed resources.
**Note:** Because
Daily Scheduled Hours)
are a part of Assignments, they can be affected when an assignment changes.'
paths:
/assignments:
get:
summary: Fetching a list of Assignments
description: 'For Account Administrators, returns task assignments in all projects across an account.
For non-Account Administrators, returns task assignments only in projects they are part of.
This endpoint returns structured Assignment 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 `assignments` top-level JSON key.
Please see our Response Format section for more information.'
operationId: Get Assignments
tags:
- Assignments
parameters:
- in: query
name: assignee_id
description: Only includes assignments that belong to the specified user ID.
schema:
type: integer
format: int32
- 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: current
description: Only includes assignments that are active.
schema:
type: boolean
- 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: in_unarchived_stories
description: 'Only includes assignments that belong to inactive tasks.
(Inactive tasks can exist in active projects, and vice versa.).'
schema:
type: boolean
default: true
- in: query
name: in_unarchived_workspaces
description: Only includes assignments that belong to active projects.
schema:
type: boolean
default: true
- 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`.
- `assignee` (User) - Retrieves the user assigned to the task. The response will include `assignee_id`, which references the data in the `users` top-level key.
- `external_references` (ExternalReference) - Includes references to external integrations for this object.
- `story` (Story) - Retrieves the task. The response will include `story_id`, which references the data in the `stories` top-level key.
- `story_allocation_days` (StoryAllocationDay) - Retrieves the Story Allocation Days (i.e. Daily Scheduled Hours) for the resource assigned to the task. When using this
value, the `plannable` filter must be set to `true`. To retrieve story allocation days for unnamed resources, also set
the `include_unnamed` filter to `true`. The response will include `story_allocation_day_ids`, which references the data
in the `story_allocation_days` top-level key.'
schema:
type: string
- in: query
name: include_unnamed
required: false
description: "Includes task assignments to unnamed resources. Think of unnamed resources as placeholders;\n it indicates the need for a certain role, before knowing who will fill it. Set to `False` by default."
schema:
type: boolean
default: false
- 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: created_at:desc
- 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: plannable
required: false
description: "Filters for assignments which the requester can view and create\n [Daily Scheduled Hours](/tag/Daily-Scheduled-Hours-(Story-Allocation-Days)) for. Must be set to `true` when using the `include` parameter with the `story_allocation_days` association."
schema:
type: boolean
- in: query
name: resource_id
description: Only includes assignments that belong to the specified resource ID.
schema:
type: integer
format: int32
- in: query
name: story_id
description: Only includes assignments that belong to the specified task ID.
schema:
type: integer
format: int32
- in: query
name: uncurrent
description: Only includes assignments that are inactive.
schema:
type: boolean
- 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: Only includes assignments that belong to the specified project ID.
schema:
type: integer
format: int32
responses:
'200':
description: A list of Assignments 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
assignments:
type: object
additionalProperties:
$ref: '#/components/schemas/Assignment'
external_references:
type: object
additionalProperties:
$ref: '#/components/schemas/ExternalReference'
stories:
type: object
additionalProperties:
$ref: '#/components/schemas/Story'
users:
type: object
additionalProperties:
$ref: '#/components/schemas/User'
story_allocation_days:
type: object
additionalProperties:
$ref: '#/components/schemas/StoryAllocationDay'
'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 Assignment
description: 'This endpoint returns structured Assignment 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 `assignments` top-level JSON key.
Please see our Response Format section for more information.'
operationId: Create Assignment
tags:
- Assignments
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`.
- `assignee` (User) - Retrieves the user assigned to the task. The response will include `assignee_id`, which references the data in the `users` top-level key.
- `external_references` (ExternalReference) - Includes references to external integrations for this object.
- `story` (Story) - Retrieves the task. The response will include `story_id`, which references the data in the `stories` top-level key.
- `story_allocation_days` (StoryAllocationDay) - Retrieves the Story Allocation Days (i.e. Daily Scheduled Hours) for the resource assigned to the task. When using this
value, the `plannable` filter must be set to `true`. To retrieve story allocation days for unnamed resources, also set
the `include_unnamed` filter to `true`. The response will include `story_allocation_day_ids`, which references the data
in the `story_allocation_days` top-level key.'
schema:
type: string
responses:
'200':
description: Assignment 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
assignments:
type: object
additionalProperties:
$ref: '#/components/schemas/Assignment'
external_references:
type: object
additionalProperties:
$ref: '#/components/schemas/ExternalReference'
stories:
type: object
additionalProperties:
$ref: '#/components/schemas/Story'
users:
type: object
additionalProperties:
$ref: '#/components/schemas/User'
story_allocation_days:
type: object
additionalProperties:
$ref: '#/components/schemas/StoryAllocationDay'
'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:
assignment:
type: object
properties:
story_id:
type: integer
format: int32
description: The ID of the task being assigned to a resource.
assignee_id:
type: integer
format: int32
description: 'The ID of the user the assignment is for. Provide either `assignee_id` or `resource_id`.
If both are provided, `resource_id` overrides `assignee_id`.'
resource_id:
type: integer
format: int32
description: 'The ID of the resource the assignment is for. Provide either `resource_id` or `assignee_id`.
If both are provided, `resource_id` overrides `assignee_id`.'
current:
type: boolean
description: 'Whether the assignment is active. `True` indicates an active
assignment, and `False` indicates inactive.
Assignments cannot be deleted,
but are considered inactive when a resource is unassigned from a task.'
estimated_minutes:
type: integer
format: int32
description: The number of minutes the resource is estimated to work on the task.
external_reference:
type: object
description: 'Typically populated programmatically by a third party system via an integration, this is an optional
object that holds data from an external system. It connects objects in an external system with objects in
Kantata OX (for example, to connect a Jira issue to a Kantata OX Project).'
properties:
service_name:
type: string
description: The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique.
service_model:
type: string
description: The object type of the external object this external reference belongs to.
service_model_ref:
type: string
description: The object ID of the external object this external reference belongs to.
external_message:
type: string
description: The message on the external object.
external_link:
type: string
description: The link to the external object.
external_status:
type: string
description: The status of the external object in the external system.
locked:
type: boolean
description: Whether the subject is locked.
required:
- service_name
- service_model
- service_model_ref
required:
- story_id
required: true
/assignments/{id}:
get:
summary: Fetching a single Assignment
description: 'This endpoint returns structured Assignment 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 `assignments` top-level JSON key.
Please see our Response Format section for more information.'
operationId: Get Assignment
tags:
- Assignments
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`.
- `assignee` (User) - Retrieves the user assigned to the task. The response will include `assignee_id`, which references the data in the `users` top-level key.
- `external_references` (ExternalReference) - Includes references to external integrations for this object.
- `story` (Story) - Retrieves the task. The response will include `story_id`, which references the data in the `stories` top-level key.
- `story_allocation_days` (StoryAllocationDay) - Retrieves the Story Allocation Days (i.e. Daily Scheduled Hours) for the resource assigned to the task. When using this
value, the `plannable` filter must be set to `true`. To retrieve story allocation days for unnamed resources, also set
the `include_unnamed` filter to `true`. The response will include `story_allocation_day_ids`, which references the data
in the `story_allocation_days` top-level key.'
schema:
type: string
responses:
'200':
description: The Assignment 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
assignments:
type: object
additionalProperties:
$ref: '#/components/schemas/Assignment'
external_references:
type: object
additionalProperties:
$ref: '#/components/schemas/ExternalReference'
stories:
type: object
additionalProperties:
$ref: '#/components/schemas/Story'
users:
type: object
additionalProperties:
$ref: '#/components/schemas/User'
story_allocation_days:
type: object
additionalProperties:
$ref: '#/components/schemas/StoryAllocationDay'
'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'
put:
summary: Updating an existing Assignment
description: 'This endpoint returns structured Assignment 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 `assignments` top-level JSON key.
Please see our Response Format section for more information.'
operationId: Update Assignment
tags:
- Assignments
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`.
- `assignee` (User) - Retrieves the user assigned to the task. The response will include `assignee_id`, which references the data in the `users` top-level key.
- `external_references` (ExternalReference) - Includes references to external integrations for this object.
- `story` (Story) - Retrieves the task. The response will include `story_id`, which references the data in the `stories` top-level key.
- `story_allocation_days` (StoryAllocationDay) - Retrieves the Story Allocation Days (i.e. Daily Scheduled Hours) for the resource assigned to the task. When using this
value, the `plannable` filter must be set to `true`. To retrieve story allocation days for unnamed resources, also set
the `include_unnamed` filter to `true`. The response will include `story_allocation_day_ids`, which references the data
in the `story_allocation_days` top-level key.'
schema:
type: string
responses:
'200':
description: Assignment 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
assignments:
type: object
additionalProperties:
$ref: '#/components/schemas/Assignment'
external_references:
type: object
additionalProperties:
$ref: '#/components/schemas/ExternalReference'
stories:
type: object
additionalProperties:
$ref: '#/components/schemas/Story'
users:
type: object
additionalProperties:
$ref: '#/components/schemas/User'
story_allocation_days:
type: object
additionalProperties:
$ref: '#/components/schemas/StoryAllocationDay'
'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:
assignment:
type: object
properties:
assignee_id:
type: integer
format: int32
description: 'The ID of the user the assignment is for. Provide either `assignee_id` or `resource_id`.
If both are provided, `resource_id` overrides `assignee_id`.'
resource_id:
type: integer
format: int32
description: 'The ID of the resource the assignment is for. Provide either `resource_id` or `assignee_id`.
If both are provided, `resource_id` overrides `assignee_id`.'
current:
type: boolean
description: Whether the assignment is active. Set as `true` to assign the resource to the task. Set as `false` to unassign the resource from the task.
estimated_minutes:
type: integer
format: int32
description: The number of minutes the resource is estimated to work on the task.
external_reference:
type: object
description: 'Typically populated programmatically by a third party system via an integration, this is an optional
object that holds data from an external system. It connects objects in an external system with objects in
Kantata OX (for example, to connect a Jira issue to a Kantata OX Project).'
properties:
service_name:
type: string
description: The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique.
service_model:
type: string
description: The object type of the external object this external reference belongs to.
service_model_ref:
type: string
description: The object ID of the external object this external reference belongs to.
external_message:
type: string
description: The message on the external object.
external_link:
type: s
# --- truncated at 32 KB (67 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mavenlink/refs/heads/main/openapi/mavenlink-assignments-api-openapi.yml