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 Skills 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: Skills
description: 'Skills are used in Kantata OX to describe capabilities of users for the purposes of resource planning.
They can be associated with a user through a Skill Membership.
A user can be associated with up to 200 skills.
This model includes categories such as ''Skill'', ''Language'', ''Certification'' and ''Other''.'
paths:
/skills:
get:
summary: Fetching a list of Skills
description: 'The Skills endpoint provides a list of every Skill that belongs to the Account of the User making the request.
The response will contain an array of Skill objects, sorted alphabetically by the `name` attribute.
**NOTE:** You cannot create more than 5000 skills per account.
This endpoint returns structured Skill 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 `skills` top-level JSON key.
Please see our Response Format section for more information.'
operationId: Get Skills
tags:
- Skills
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: except
description: Includes the skills that are not in the passed in set of skill ids. For example, '10,15'.
schema:
type: string
- 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: for_users
description: Includes skills that are not already associated with these users. For example, '10,15'.
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.
- `skill_category` (SkillCategory) - The Skill Category under which the Skill is grouped.'
schema:
type: string
- in: query
name: matching
description: Includes skills with a name that matches the search string.
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: `alphabetical:asc` and `alphabetical:desc`.'
schema:
type: string
default: alphabetical:asc
- 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: skill_category_ids
description: Includes skills that are associated with these skill categories. For example, '2,25'.
schema:
type: string
- in: query
name: unassigned_skills_for_estimate_scenario_resource
description: Includes the skills that an estimate scenario resource has not been assigned.
schema:
type: integer
format: int32
- in: query
name: unassigned_skills_for_project_template_assignment
description: Includes the skills that a project template assignment has not been assigned.
schema:
type: integer
format: int32
- in: query
name: unassigned_skills_for_user
description: Includes the skills that a user has not been assigned.
schema:
type: integer
format: int32
- in: query
name: unassigned_skills_for_workspace_resource
description: Includes the skills that a workspace resource has not been assigned.
schema:
type: integer
format: int32
- 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
responses:
'200':
description: A list of Skills 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
skills:
type: object
additionalProperties:
$ref: '#/components/schemas/Skill'
external_references:
type: object
additionalProperties:
$ref: '#/components/schemas/ExternalReference'
skill_categories:
type: object
additionalProperties:
$ref: '#/components/schemas/SkillCategory'
'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 Skill
description: 'Adds a new skill to the account.
**Note:** You cannot create more than 5000 skills per account.
**Bulk Create**
This endpoint supports bulk creating up to 200 objects. In the request body, set the top-level key to its plural form and place the objects in an array. Example:
```
{
"skills": [
{
"name": "Skill",
"skill_category_id": 123
},
{
"name": "Skill 2",
"skill_category_id": 456
}
]
}
```
This endpoint returns structured Skill 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 `skills` top-level JSON key.
Please see our Response Format section for more information.'
operationId: Create Skill
tags:
- Skills
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.
- `skill_category` (SkillCategory) - The Skill Category under which the Skill is grouped.'
schema:
type: string
responses:
'200':
description: Skill 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
skills:
type: object
additionalProperties:
$ref: '#/components/schemas/Skill'
external_references:
type: object
additionalProperties:
$ref: '#/components/schemas/ExternalReference'
skill_categories:
type: object
additionalProperties:
$ref: '#/components/schemas/SkillCategory'
'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:
skill:
type: object
properties:
name:
type: string
description: The name of the skill to be created.
max_level:
type: string
description: The max number of levels allowed for the skill and must be either 1 or 5.
skill_category_id:
type: integer
format: int32
description: The id of the skill category associated with this skill.
description:
type: string
description: The description of the skill.
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.
status:
type: string
description: The status of the integration. Options are `successful`, `pending`, or `failed`.
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:
- name
- max_level
- skill_category_id
required: true
/skills/{id}:
get:
summary: Fetching a single Skill
description: 'This endpoint returns structured Skill 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 `skills` top-level JSON key.
Please see our Response Format section for more information.'
operationId: Get Skill
tags:
- Skills
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.
- `skill_category` (SkillCategory) - The Skill Category under which the Skill is grouped.'
schema:
type: string
responses:
'200':
description: The Skill 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
skills:
type: object
additionalProperties:
$ref: '#/components/schemas/Skill'
external_references:
type: object
additionalProperties:
$ref: '#/components/schemas/ExternalReference'
skill_categories:
type: object
additionalProperties:
$ref: '#/components/schemas/SkillCategory'
'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 Skill
description: 'This endpoint returns structured Skill 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 `skills` top-level JSON key.
Please see our Response Format section for more information.'
operationId: Update Skill
tags:
- Skills
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.
- `skill_category` (SkillCategory) - The Skill Category under which the Skill is grouped.'
schema:
type: string
responses:
'200':
description: Skill 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
skills:
type: object
additionalProperties:
$ref: '#/components/schemas/Skill'
external_references:
type: object
additionalProperties:
$ref: '#/components/schemas/ExternalReference'
skill_categories:
type: object
additionalProperties:
$ref: '#/components/schemas/SkillCategory'
'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:
skill:
type: object
properties:
name:
type: string
description: The name of the skill to be created.
max_level:
type: string
description: The max number of levels allowed for the skill and must be either 1 or 5.
skill_category_id:
type: integer
format: int32
description: The id of the skill category associated with this skill.
description:
type: string
description: The description of the skill.
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.
status:
type: string
description: The status of the integration. Options are `successful`, `pending`, or `failed`.
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: true
delete:
summary: Deleting an existing Skill
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 Skill
tags:
- Skills
parameters:
- in: path
name: id
required: true
description: The ID of the Model.
schema:
type: integer
responses:
'204':
description: Skill 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:
# --- truncated at 32 KB (38 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mavenlink/refs/heads/main/openapi/mavenlink-skills-api-openapi.yml