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 Participations 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: Participations
description: 'A participation represents the relationship between a participant and a project, including a participant''s permission level,
whether they''re a provider or client, and many other properties. See the 200 status code
response sample for an example of participation properties you can access.'
paths:
/participations:
get:
summary: Fetching a list of Participations
description: 'The Participations index action only returns participations from projects that are visible to the requester.
See the Projects KB documentation for more information about how visibility restrictions work.
This endpoint returns structured Participation 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 `participations` top-level JSON key.
Please see our Response Format section for more information.'
operationId: Get Participations
tags:
- Participations
parameters:
- in: query
name: workspace_id
required: true
description: This parameter is required to identify the project you want to retrieve participations for.
schema:
type: integer
format: int32
- in: query
name: by_user
description: Retrieves participations for the specified user ID.
schema:
type: integer
format: int32
- in: query
name: by_user_full_name
description: Matches against users' full names.
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: include
description: 'Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.
- `active_roles` (Role) - Retrieves all of the project roles of the participant. The response will include `active_role_ids`, which references the data in the `roles` top-level key.
- `external_references` (ExternalReference) - Includes references to external integrations for this object.
- `primary_role` (Role) - Retrieves account role of the participant. Only visible when the authenticated user is on the same account the project is on. The response will include `primary_role_id`, which references the data in the `roles` top-level key.
- `user` (User) - Retrieves the user (also known as the participant). The response will include `user_id`, which references the data in the `users` top-level key.
- `workspace` (Workspace) - Retrieves the project. The response will include `workspace_id`, which references the data in the `workspaces` top-level key.
- `workspace_resources` (WorkspaceResource) - Retrieves the resource(s) associated with the participation, ordered alphabetically. The response will include `workspace_resource_ids`, which references the data in the `workspace_resources` top-level key.
- `workspace_role` (Role) - Retrieves the primary project role for the participant. The response will include `workspace_role_id`, which references the data in the `roles` top-level key.'
schema:
type: string
- in: query
name: mavens_only
description: Only consultant participations.
schema:
type: boolean
- in: query
name: not_assigned_to_story
description: Not assigned to the specified story ID.
schema:
type: integer
format: int32
- in: query
name: not_following_story
description: Not following the specified story ID.
schema:
type: integer
format: int32
- 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: optional_fields
description: Allows you to request one or more optional fields as an array.
schema:
type: array
items:
type: string
enum:
- access_level
- is_foreign_participant
- can_schedule_their_hours
- can_schedule_team_hours
- permissions_label
- in: query
name: order
description: 'Supply `order` with the name of a valid sort field for the endpoint and a direction.
Valid values: `updated_at:asc`, `updated_at:desc`, `user_name:asc`, and `user_name: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: 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 Participations 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
participations:
type: object
additionalProperties:
$ref: '#/components/schemas/Participation'
external_references:
type: object
additionalProperties:
$ref: '#/components/schemas/ExternalReference'
users:
type: object
additionalProperties:
$ref: '#/components/schemas/User'
workspaces:
type: object
additionalProperties:
$ref: '#/components/schemas/Workspace'
roles:
type: object
additionalProperties:
$ref: '#/components/schemas/Role'
workspace_resources:
type: object
additionalProperties:
$ref: '#/components/schemas/WorkspaceResource'
'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 Participation
description: 'Adds a user to a project (workspace).
**Bulk Create**
This endpoint supports bulk creating up to 100 objects. In the request body, set the top-level key to its plural form and place the objects in an array. Example:
```
{
"participations": [
{
"workspace_id": 123,
"role": "maven",
"user_id": 111
},
{
"workspace_id": 123,
"role": "maven",
"user_id": 222
}
]
}
```
This endpoint returns structured Participation 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 `participations` top-level JSON key.
Please see our Response Format section for more information.'
operationId: Create Participation
tags:
- Participations
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`.
- `active_roles` (Role) - Retrieves all of the project roles of the participant. The response will include `active_role_ids`, which references the data in the `roles` top-level key.
- `external_references` (ExternalReference) - Includes references to external integrations for this object.
- `primary_role` (Role) - Retrieves account role of the participant. Only visible when the authenticated user is on the same account the project is on. The response will include `primary_role_id`, which references the data in the `roles` top-level key.
- `user` (User) - Retrieves the user (also known as the participant). The response will include `user_id`, which references the data in the `users` top-level key.
- `workspace` (Workspace) - Retrieves the project. The response will include `workspace_id`, which references the data in the `workspaces` top-level key.
- `workspace_resources` (WorkspaceResource) - Retrieves the resource(s) associated with the participation, ordered alphabetically. The response will include `workspace_resource_ids`, which references the data in the `workspace_resources` top-level key.
- `workspace_role` (Role) - Retrieves the primary project role for the participant. The response will include `workspace_role_id`, which references the data in the `roles` 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:
- access_level
- is_foreign_participant
- can_schedule_their_hours
- can_schedule_team_hours
- permissions_label
responses:
'200':
description: Participation 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
participations:
type: object
additionalProperties:
$ref: '#/components/schemas/Participation'
external_references:
type: object
additionalProperties:
$ref: '#/components/schemas/ExternalReference'
users:
type: object
additionalProperties:
$ref: '#/components/schemas/User'
workspaces:
type: object
additionalProperties:
$ref: '#/components/schemas/Workspace'
roles:
type: object
additionalProperties:
$ref: '#/components/schemas/Role'
workspace_resources:
type: object
additionalProperties:
$ref: '#/components/schemas/WorkspaceResource'
'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:
participation:
type: object
properties:
can_invite:
type: boolean
description: Permission for the participant to invite other users into the project.
can_schedule_their_hours:
type: boolean
description: Permission for the participant to schedule their own hours.
can_schedule_team_hours:
type: boolean
description: Permission for the participant to schedule hours for project team members.
can_edit_todos:
type: boolean
description: Permission for the participant to edit To Dos.
access_level:
type: string
description: 'Access level for the user in the workspace. Valid options include "edit_tasks", "view_tasks", "edit_time_and_expenses", "view_time_and_expenses",
"edit_financials", "view_financials", "admin". Legacy options include "financial", "time_logging", "collaboration".'
workspace_id:
type: integer
format: int32
description: The ID of the project the participation will belong to.
role:
type: string
description: The team a participant is on in a project, defined as either the "maven" (provider) or "buyer" (client) team.
user_id:
type: integer
format: int32
description: The ID of the user that wants to participate in the project.
permissions:
type: string
description: 'Permission for the user in the workspace. It must be any combination of "edit", "view_only", "view_and_post",
"can_edit", "can_post", "can_edit_expense", "can_edit_time", "can_invite", "can_schedule_their_hours", or
"can_schedule_team_hours" delimited by commas. ex. "can_post,can_edit_time"
If "can_invite", "can_schedule_their_hours", or "can_schedule_team_hours" are not set—either via the individual
fields or the `permissions` string—they will inherit the default values defined in the account''s Project Permissions Defaults.'
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
- role
required: true
/participations/{id}:
get:
summary: Fetching a single Participation
description: 'This endpoint returns structured Participation 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 `participations` top-level JSON key.
Please see our Response Format section for more information.'
operationId: Get Participation
tags:
- Participations
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`.
- `active_roles` (Role) - Retrieves all of the project roles of the participant. The response will include `active_role_ids`, which references the data in the `roles` top-level key.
- `external_references` (ExternalReference) - Includes references to external integrations for this object.
- `primary_role` (Role) - Retrieves account role of the participant. Only visible when the authenticated user is on the same account the project is on. The response will include `primary_role_id`, which references the data in the `roles` top-level key.
- `user` (User) - Retrieves the user (also known as the participant). The response will include `user_id`, which references the data in the `users` top-level key.
- `workspace` (Workspace) - Retrieves the project. The response will include `workspace_id`, which references the data in the `workspaces` top-level key.
- `workspace_resources` (WorkspaceResource) - Retrieves the resource(s) associated with the participation, ordered alphabetically. The response will include `workspace_resource_ids`, which references the data in the `workspace_resources` top-level key.
- `workspace_role` (Role) - Retrieves the primary project role for the participant. The response will include `workspace_role_id`, which references the data in the `roles` 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:
- access_level
- is_foreign_participant
- can_schedule_their_hours
- can_schedule_team_hours
- permissions_label
responses:
'200':
description: The Participation 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
participations:
type: object
additionalProperties:
$ref: '#/components/schemas/Participation'
external_references:
type: object
additionalProperties:
$ref: '#/components/schemas/ExternalReference'
users:
type: object
additionalProperties:
$ref: '#/components/schemas/User'
workspaces:
type: object
additionalProperties:
$ref: '#/components/schemas/Workspace'
roles:
type: object
additionalProperties:
$ref: '#/components/schemas/Role'
workspace_resources:
type: object
additionalProperties:
$ref: '#/components/schemas/WorkspaceResource'
'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 Participation
description: 'This endpoint returns structured Participation 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 `participations` top-level JSON key.
Please see our Response Format section for more information.'
operationId: Update Participation
tags:
- Participations
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`.
- `active_roles` (Role) - Retrieves all of the project roles of the participant. The response will include `active_role_ids`, which references the data in the `roles` top-level key.
- `external_references` (ExternalReference) - Includes references to external integrations for this object.
- `primary_role` (Role) - Retrieves account role of the participant. Only visible when the authenticated user is on the same account the project is on. The response will include `primary_role_id`, which references the data in the `roles` top-level key.
- `user` (User) - Retrieves the user (also known as the participant). The response will include `user_id`, which references the data in the `users` top-level key.
- `workspace` (Workspace) - Retrieves the project. The response will include `workspace_id`, which references the data in the `workspaces` top-level key.
- `workspace_resources` (WorkspaceResource) - Retrieves the resource(s) associated with the participation, ordered alphabetically. The response will include `workspace_resource_ids`, which references the data in the `workspace_resources` top-level key.
- `workspace_role` (Role) - Retrieves the primary project role for the participant. The response will include `workspace_role_id`, which references the data in the `roles` 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:
- access_level
- is_foreign_participant
- can_schedule_their_hours
- can_schedule_team_hours
- permissions_label
responses:
'200':
description: Participation 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
p
# --- truncated at 32 KB (87 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mavenlink/refs/heads/main/openapi/mavenlink-participations-api-openapi.yml