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 Workspace Resources 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: Workspace Resources
description: A workspace resource is the object that is tied to assignments and allocations within a Workspace.
paths:
/workspace_resources:
get:
summary: Fetching a list of Workspace Resources
description: 'This endpoint returns structured Workspace Resource 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 `workspace_resources` top-level JSON key.
Please see our Response Format section for more information.'
operationId: Get Workspace Resources
tags:
- Workspace Resources
parameters:
- in: query
name: by_custom_choice_value
description: 'Filter by a custom field choice value, represented as a string with the custom field ID, followed by a
colon, and then comma-separated custom field choice value IDs. The custom field choice value can also be
the word `blank`. Multiple custom fields can be delimited by semicolons or by parentheses and colons.
The following formats are supported:
- `custom_field_ID:choice_value_ID`
- `custom_field_ID:choice_value_1_ID,choice_value_2_ID`
- `custom_field_ID:blank`
- `(custom_field_1_ID:choice_value_1_ID,choice_value_2_ID):(custom_field_2_ID:choice_value_3_ID)`.'
schema:
type: string
- in: query
name: by_custom_currency_value
description: 'Filter by a custom field currency value, represented as a string with the custom field ID, followed by a
colon, and then the currency value. Optionally, the currency [ISO code](https://mavenlink.zendesk.com/hc/en-us/articles/360041576473) can be supplied as well, separated
from the currency value by another colon. Multiple custom fields can be delimited by semicolons or by parentheses and colons.
The following formats are supported:
- `(1:200.2:USD):(2:100)`.'
schema:
type: string
- in: query
name: by_custom_date_value
description: 'Filter by a custom field date value, represented as a string with the custom field ID, followed by a
colon, the starting date, another colon, and then the ending date. You can provide both a starting date
and ending date, or provide just one. Multiple custom fields can be delimited by semicolons or by parentheses and colons.
The following formats are supported:
- `(1:2014-12-05:2014-12-25):(2:2014-12-05)`.'
schema:
type: string
- in: query
name: by_custom_number_value
description: 'Filter by a custom field number value, represented as a string with the custom field ID, followed by a
colon, and then the number value. Multiple custom fields can be delimited by semicolons or by parentheses and colons.
The following formats are supported:
- `(1:200):(2:101)`.'
schema:
type: string
- in: query
name: by_custom_text_value
description: 'Filter by a custom field text value, represented as a string with the custom field ID, followed by a
colon, and then the text value. Multiple custom fields can be delimited by semicolons or by parentheses and colons.
The following formats are supported:
- `(1:something):(2:else)`
- `(1:something):(1:else)` (multiple values for the same field, returns objects matching any value)
- `1` (bare field ID with no value, returns all objects that have any value for that field).'
schema:
type: string
- 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: 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: has_value_for_custom_field_ids
description: Filter by the presence of a custom field value for the specified comma-separated custom field ID(s).
schema:
type: string
- 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`.
- `custom_field_values` (CustomFieldValue) - Retrieves the custom field values for the resource. The response will include `custom_field_value_ids`, which references the data in the `custom_field_values` top-level key.
- `external_references` (ExternalReference) - Includes references to external integrations for this object.
- `organization_membership` (OrganizationMembership) - Retrieves the organization memberships for the resource. The response will include `organization_membership_id`, which references the data in the `organization_memberships` top-level key.
- `participation` (Participation) - Retrieves the participation associated with the resource. The response will include `participation_id`, which references the data in the `participations` top-level key.
- `role` (Role) - Retrieves the role for this resource. The response will include `role_id`, which references the data in the `roles` top-level key.
- `user` (User) - Retrieves the user associated with the resource. The response will include `user_id`, which references the data in the `users` top-level key. For unnamed resources, the `user_id` will be `null`.
- `workspace` (Workspace) - Retrieves the workspace (project) the resource is in. The response will include `workspace_id`, which references the data in the `workspaces` top-level key.'
schema:
type: string
- in: query
name: include_unnamed
required: false
description: Returns Unnamed Resources in addition to Named Resources.
schema:
type: boolean
- in: query
name: matching
description: Show Resources associated with a User that matches the specified parameter or has a Role that matches the specified parameter.
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: only_unnamed
required: false
description: Returns only Unnamed Resources.
schema:
type: boolean
- in: query
name: optional_fields
description: Allows you to request one or more optional fields as an array.
schema:
type: array
items:
type: string
enum:
- resource_bill_rate
- resource_cost_rate
- in: query
name: order
description: 'Supply `order` with the name of a valid sort field for the endpoint and a direction.
Valid values: `alphabetical`, `alphabetically:asc`, `alphabetically:desc`, `created_at:asc`, `created_at:desc`, `updated_at:asc`, and `updated_at:desc`.'
schema:
type: string
default: updated_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: potential_workspace_resource_for_story_with_unnamed_resources
description: Takes a Reference to a Story Id. Show only Resources that are available to assign for specified Story.
schema:
type: integer
format: int32
- in: query
name: potential_workspace_resources_for_reassignment
description: Takes an Assignment Id. Shows only Resources that can be reassigned to the specified assignment.
schema:
type: integer
format: int32
- in: query
name: potential_workspace_resources_for_story
description: Takes a Reference to a Story Id Show only Resources that have an user assigned, and are available to assign for specified Story.
schema:
type: integer
format: int32
- in: query
name: providers
description: Show only Resources that have an user assigned, and are consultants in the workspace.
schema:
type: boolean
- in: query
name: providers_with_unnamed
description: Show only Resources that have consultant users or no users at all.
schema:
type: boolean
- in: query
name: role_id
required: false
description: Returns workspace resources for a specified role in a workspace. Returns workspace resources for a specified role when only the role is provided.
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: user_id
required: false
description: Returns workspace resources for a specified user in a workspace. Returns workspace resources for a specified user when only the user is provided.
schema:
type: integer
format: int32
- in: query
name: with_organizations
description: Only includes Resources that have an organization (true) or only includes Resources that do not have an organization (false).
schema:
type: boolean
- 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
required: false
description: Id for a specified workspace you wish to retrieve.
schema:
type: integer
format: int32
responses:
'200':
description: A list of Workspace Resources 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
workspace_resources:
type: object
additionalProperties:
$ref: '#/components/schemas/WorkspaceResource'
external_references:
type: object
additionalProperties:
$ref: '#/components/schemas/ExternalReference'
users:
type: object
additionalProperties:
$ref: '#/components/schemas/User'
roles:
type: object
additionalProperties:
$ref: '#/components/schemas/Role'
organization_memberships:
type: object
additionalProperties:
$ref: '#/components/schemas/OrganizationMembership'
participations:
type: object
additionalProperties:
$ref: '#/components/schemas/Participation'
workspaces:
type: object
additionalProperties:
$ref: '#/components/schemas/Workspace'
custom_field_values:
type: object
additionalProperties:
$ref: '#/components/schemas/CustomFieldValue'
'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 Workspace Resource
description: 'Adds a named or unnamed resource to a project (workspace).
**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:
```
{
"workspace_resources": [
{
"workspace_id": 123,
"user_id": 111,
"role_id": 555
},
{
"workspace_id": 123,
"user_id": 222,
"role_id": 666
}
]
}
```
This endpoint returns structured Workspace Resource 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 `workspace_resources` top-level JSON key.
Please see our Response Format section for more information.'
operationId: Create Workspace Resource
tags:
- Workspace Resources
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`.
- `custom_field_values` (CustomFieldValue) - Retrieves the custom field values for the resource. The response will include `custom_field_value_ids`, which references the data in the `custom_field_values` top-level key.
- `external_references` (ExternalReference) - Includes references to external integrations for this object.
- `organization_membership` (OrganizationMembership) - Retrieves the organization memberships for the resource. The response will include `organization_membership_id`, which references the data in the `organization_memberships` top-level key.
- `participation` (Participation) - Retrieves the participation associated with the resource. The response will include `participation_id`, which references the data in the `participations` top-level key.
- `role` (Role) - Retrieves the role for this resource. The response will include `role_id`, which references the data in the `roles` top-level key.
- `user` (User) - Retrieves the user associated with the resource. The response will include `user_id`, which references the data in the `users` top-level key. For unnamed resources, the `user_id` will be `null`.
- `workspace` (Workspace) - Retrieves the workspace (project) the resource is in. The response will include `workspace_id`, which references the data in the `workspaces` top-level key.'
schema:
type: string
- in: query
name: optional_fields
description: Allows you to request one or more optional fields as an array.
schema:
type: array
items:
type: string
enum:
- resource_bill_rate
- resource_cost_rate
responses:
'200':
description: Workspace Resource 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
workspace_resources:
type: object
additionalProperties:
$ref: '#/components/schemas/WorkspaceResource'
external_references:
type: object
additionalProperties:
$ref: '#/components/schemas/ExternalReference'
users:
type: object
additionalProperties:
$ref: '#/components/schemas/User'
roles:
type: object
additionalProperties:
$ref: '#/components/schemas/Role'
organization_memberships:
type: object
additionalProperties:
$ref: '#/components/schemas/OrganizationMembership'
participations:
type: object
additionalProperties:
$ref: '#/components/schemas/Participation'
workspaces:
type: object
additionalProperties:
$ref: '#/components/schemas/Workspace'
custom_field_values:
type: object
additionalProperties:
$ref: '#/components/schemas/CustomFieldValue'
'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:
workspace_resource:
type: object
properties:
workspace_id:
type: integer
format: int32
description: The workspace ID associated with this resource.
user_id:
type: integer
format: int32
description: The user ID associated with this resource. A null value indicates that this is an unnamed resource.
role_id:
type: integer
format: int32
description: 'The role ID associated with this resource. The role ID is a required attribute to create unnamed
resources. This defaults to the user''s primary project role if the user is specified.'
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:
- workspace_id
required: true
/workspace_resources/allocations_matching_scheduled_hours:
post:
summary: Creating Allocations from Scheduled Hours for Resources
description: 'This will create allocations for workspace resources based on their scheduled hours.
This endpoint is only usable for Account Administrators and users with `Users can edit
allocations for unnamed resources` or `Users can edit allocations for named resources`
access in the `Edit Allocations` section of the `Resource Management` Access Group Set.
This endpoint returns structured Workspace Resource 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 `workspace_resources` top-level JSON key.
Please see our Response Format section for more information.'
operationId: Create Workspace Resource Allocations From Scheduled Hours
tags:
- Workspace Resources
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`.
- `custom_field_values` (CustomFieldValue) - Retrieves the custom field values for the resource. The response will include `custom_field_value_ids`, which references the data in the `custom_field_values` top-level key.
- `external_references` (ExternalReference) - Includes references to external integrations for this object.
- `organization_membership` (OrganizationMembership) - Retrieves the organization memberships for the resource. The response will include `organization_membership_id`, which references the data in the `organization_memberships` top-level key.
- `participation` (Participation) - Retrieves the participation associated with the resource. The response will include `participation_id`, which references the data in the `participations` top-level key.
- `role` (Role) - Retrieves the role for this resource. The response will include `role_id`, which references the data in the `roles` top-level key.
- `user` (User) - Retrieves the user associated with the resource. The response will include `user_id`, which references the data in the `users` top-level key. For unnamed resources, the `user_id` will be `null`.
- `workspace` (Workspace) - Retrieves the workspace (project) the resource is in. The response will include `workspace_id`, which references the data in the `workspaces` top-level key.'
schema:
type: string
- in: query
name: optional_fields
description: Allows you to request one or more optional fields as an array.
schema:
type: array
items:
type: string
enum:
- resource_bill_rate
- resource_cost_rate
responses:
'200':
description: Workspace Resource has been created.
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: Indicates if workspace allocations were created.
'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:
data:
type: array
description: An array of objects representing allocations to create for the specified resources.
items:
type: object
properties:
resource_ids:
type: array
items:
type: integer
format: int32
description: "An array of IDs of the resources to create allocations for. NOTE: This is only applicable when updating multiple resources via\n `workspace_resources/allocations_matching_scheduled_hours`."
hard:
type: boolean
description: Whether the allocation is a Hard Allocation (“true”) or Soft (“false”). This value must be set to `false` if you are including any unnamed resources in your request.
occurrence:
type: object
description: The timeframe of scheduled hours in which to create allocations for.
properties:
type:
type: string
description: The timeframe in which to allocate the scheduled hours. Accepted values are `anytime`, `after`, `before`, and `between`.
enum:
- anytime
- a
# --- truncated at 32 KB (113 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mavenlink/refs/heads/main/openapi/mavenlink-workspace-resources-api-openapi.yml