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 Users 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: Users
description: 'Users represent the individuals that are participating in Kantata OX projects . User objects are often returned as
nested JSON objects within other returned items such as posts or tasks.'
paths:
/users:
get:
summary: Fetching visible users
description: 'This endpoint allows you to access all visible users based on the permission level of the requester.
> **Note**: This endpoint relies on project participation and will not return a member of your account
who is not in a project. To see all users on the account, use the `on_my_account` option.
If the requester is an Account Administrator, the request will return all users who are participating in a project on the requester''s account.
In addition, it will return users not on the requester''s account if they are participating in any project with an account member (either on the requester''s account or their own account).
If the requester is not an Account Administrator, the request will only return users who are participating in a project with the requester.
This endpoint returns structured User 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 `users` top-level JSON key.
Please see our Response Format section for more information.'
operationId: Get Users
tags:
- Users
parameters:
- in: query
name: account_id
description: Only includes users on the specified account. This filter is not available in conjunction with the `on_my_account` option.
schema:
type: integer
format: int32
- in: query
name: account_role_ids
description: 'Only includes users with a specified role ID. (Format: ''role_id,role_id'').'
schema:
type: string
- in: query
name: all_contacts
required: false
description: Returns all users in the requester's contact list.
schema:
type: boolean
- in: query
name: assignable_to_resource
description: Only includes users who can be assigned to a project resource with a specified ID.
schema:
type: integer
format: int32
- in: query
name: belonging_to_orgs
description: 'Only includes users that belong to the specified geographies or departments (Format: ''geo_id,geo_id;dept_id,dept_id'').'
schema:
type: string
- 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: by_email_address
description: Only includes users whose email address exactly matches the specified address.
schema:
type: string
- in: query
name: by_email_addresses
description: 'Return only users whose email addresses exactly match the specified email addresses.
You can provide a list of comma-separated email addresses as a query parameter in the request URL or
provide an array of email addresses in the request body. You can specify up to 200 email addresses.'
schema:
type: string
- in: query
name: by_full_name
description: Only includes users with all or part of the specified full name.
schema:
type: string
- in: query
name: by_full_name_or_account_role
description: Only includes users with a matching full_name or default_role specified a search term.
schema:
type: string
- in: query
name: can_be_approver_in_workspace
description: Only includes users that are providers and have financial access in a project with a specified ID.
schema:
type: integer
format: int32
- in: query
name: can_view_reports
description: Only include users who have account level permission of reports viewer or above.
schema:
type: boolean
- in: query
name: clients_only
description: Only includes users that are in at least one project as a client.
schema:
type: boolean
- in: query
name: consultants_only
description: Only includes users that are in at least one project as a provider.
schema:
type: boolean
- in: query
name: contacts_on_different_account
required: false
description: Returns all the users that are in the requester's contact list, but on seperate accounts.
schema:
type: boolean
- 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`.
- `account_membership` (AccountMembership) - Retrieves the account membership of the user, which represents the relationship of a user to an account. The response will include `account_membership_id`, which references the data in the `account_memberships` top-level key.
- `custom_field_values` (CustomFieldValue) - Retrieves the user''s custom field values that are viewable for the current user. 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.
- `manager` (User) - Retrieves the user''s manager. The response will include `manager_id`, which references the data in the `users` top-level key.
- `role` (Role) - Retrieves the user''s account role. The response will include `role_id`, which references the data in the `roles` top-level key.
- `skill_memberships` (SkillMembership) - Retrieves the skill memberships of the user, which represent skills that have been assigned to a user. The response will include `skill_membership_ids`, which references the data in the `skill_memberships` top-level key. The `skill_memberships` data will include the user''s proficiency level (for skills which can be assigned proficiency levels).
- `skills` (Skill) - Retrieves the user''s skills. The response will include `skill_ids`, which references the data in the `skills` top-level key. The `skills` data will include the skill description and category ID.
- `work_samples` (WorkSample) - Retrieves the user''s portfolio items. The response will include `work_sample_ids`, which references the data in the `work_samples` top-level key.'
schema:
type: string
- in: query
name: is_project_lead
description: Only include users who have account level permission of project lead or above.
schema:
type: boolean
- in: query
name: managers
description: Only include users who are managers.
schema:
type: boolean
default: false
- in: query
name: matching
schema:
type: string
- in: query
name: not_assigned_to
description: Only includes users who are not assigned to a task with specified ID.
schema:
type: integer
format: int32
- in: query
name: not_following
description: Only includes users who are not following a task with the specified ID.
schema:
type: integer
format: int32
- in: query
name: not_on_calendars
description: 'Only includes users who are not added to the specified holiday calendars (Format: ''calendar_id,calendar_id,calendar_id''.'
schema:
type: string
- in: query
name: not_participant_in
description: Only includes users not participating in a project with a specified ID.
schema:
type: integer
format: int32
- in: query
name: on_my_account
required: false
description: Returns all users on the requester's account.
schema:
type: boolean
- in: query
name: on_my_account_or_participant_in_workspace
required: false
description: Returns all the users that are on the account, as well as all users participating in the provided workspace 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: only_possible_managees
description: Only includes possible managees on the account.
schema:
type: boolean
- in: query
name: only_possible_managers
description: Only includes possible managers on the account.
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:
- bio
- website
- city
- state
- country
- abbreviated_timezone
- last_site_activity
- classification
- 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: participant_in
description: Only includes users participating in a project with a specified ID.
schema:
type: integer
format: int32
- in: query
name: per_page
schema:
type: integer
format: int32
default: 20
maximum: 200
- in: query
name: potential_followers_for_story
description: Only includes users who are able to follow a task with the specified ID.
schema:
type: integer
format: int32
- in: query
name: provider_leads_on_account_projects
description: Only includes users who are providers and leads in projects on the requester's account.
schema:
type: boolean
- in: query
name: search
schema:
type: string
- in: query
name: show_disabled
description: Includes users with an inactive account membership and users who have been disabled by the Kantata team.
schema:
type: boolean
default: false
- in: query
name: show_users_in_insights_groups
description: Only includes users who have access to insights.
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: with_created_estimates
description: Only include users who have created an estimate.
schema:
type: boolean
default: false
- in: query
name: with_organizations
description: Only includes users that have an organization (true) or only includes users that do not have an organization (false).
schema:
type: boolean
- in: query
name: with_skills
description: 'Only includes users with a set of skills at the specified levels (Format: ''{''skill_id'':[level,level],''skill_id'':[level],''operation'':''<or/and>''}'').'
schema:
type: string
- in: query
name: with_users
description: 'Include only users for the provided IDs (Format: ''id,id,id'').'
schema:
type: array
items:
type: integer
format: int32
- 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: without_skills
description: 'Only includes users without the specified set of skills (Format: ''id,id,id'').'
schema:
type: string
- in: query
name: without_timesheet_submission
description: 'Only include users who have not submitted a timesheet in a project between the specified start and end dates. (Format: ''workspace_id:start_date:end_date'').'
schema:
type: string
- in: query
name: without_users
description: 'Exclude users for the provided IDs (Format: ''id,id,id'').'
schema:
type: array
items:
type: integer
format: int32
- in: query
name: write_access_in
description: Only includes users who are participating in a project with a specified ID, and are not read-only in the project.
schema:
type: integer
format: int32
responses:
'200':
description: A list of Users 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
users:
type: object
additionalProperties:
$ref: '#/components/schemas/User'
external_references:
type: object
additionalProperties:
$ref: '#/components/schemas/ExternalReference'
roles:
type: object
additionalProperties:
$ref: '#/components/schemas/Role'
skills:
type: object
additionalProperties:
$ref: '#/components/schemas/Skill'
skill_memberships:
type: object
additionalProperties:
$ref: '#/components/schemas/SkillMembership'
account_memberships:
type: object
additionalProperties:
$ref: '#/components/schemas/AccountMembership'
work_samples:
type: object
additionalProperties:
$ref: '#/components/schemas/WorkSample'
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'
/users/me:
get:
summary: Fetch your own data
description: 'This endpoint allows you to fetch your own data.
This endpoint returns structured User 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 `users` top-level JSON key.
Please see our Response Format section for more information.'
operationId: Get My User Data
tags:
- Users
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`.
- `account_membership` (AccountMembership) - Retrieves the account membership of the user, which represents the relationship of a user to an account. The response will include `account_membership_id`, which references the data in the `account_memberships` top-level key.
- `custom_field_values` (CustomFieldValue) - Retrieves the user''s custom field values that are viewable for the current user. 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.
- `manager` (User) - Retrieves the user''s manager. The response will include `manager_id`, which references the data in the `users` top-level key.
- `role` (Role) - Retrieves the user''s account role. The response will include `role_id`, which references the data in the `roles` top-level key.
- `skill_memberships` (SkillMembership) - Retrieves the skill memberships of the user, which represent skills that have been assigned to a user. The response will include `skill_membership_ids`, which references the data in the `skill_memberships` top-level key. The `skill_memberships` data will include the user''s proficiency level (for skills which can be assigned proficiency levels).
- `skills` (Skill) - Retrieves the user''s skills. The response will include `skill_ids`, which references the data in the `skills` top-level key. The `skills` data will include the skill description and category ID.
- `work_samples` (WorkSample) - Retrieves the user''s portfolio items. The response will include `work_sample_ids`, which references the data in the `work_samples` 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:
- bio
- website
- city
- state
- country
- abbreviated_timezone
- last_site_activity
- classification
responses:
'200':
description: A list of Users 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
users:
type: object
additionalProperties:
$ref: '#/components/schemas/User'
external_references:
type: object
additionalProperties:
$ref: '#/components/schemas/ExternalReference'
roles:
type: object
additionalProperties:
$ref: '#/components/schemas/Role'
skills:
type: object
additionalProperties:
$ref: '#/components/schemas/Skill'
skill_memberships:
type: object
additionalProperties:
$ref: '#/components/schemas/SkillMembership'
account_memberships:
type: object
additionalProperties:
$ref: '#/components/schemas/AccountMembership'
work_samples:
type: object
additionalProperties:
$ref: '#/components/schemas/WorkSample'
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'
/users/{id}:
get:
summary: Fetching a single User
description: 'This endpoint returns structured User 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 `users` top-level JSON key.
Please see our Response Format section for more information.'
operationId: Get User
tags:
- Users
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`.
- `account_membership` (AccountMembership) - Retrieves the account membership of the user, which represents the relationship of a user to an account. The response will include `account_membership_id`, which references the data in the `account_memberships` top-level key.
- `custom_field_values` (CustomFieldValue) - Retrieves the user''s custom field values that are viewable for the current user. 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.
- `manager` (User) - Retrieves the user''s manager. The response will include `manager_id`, which references the data in the `users` top-level key.
- `role` (Role) - Retrieves the user''s account role. The response will include `role_id`, which references the data in the `roles` top-level key.
- `skill_memberships` (SkillMembership) - Retrieves the skill memberships of the user, which represent skills that have been assigned to a user. The response will include `skill_membership_ids`, which references the data in the `skill_memberships` top-level key. The `skill_memberships` data will include the user''s proficiency level (for skills which can be assigned proficiency levels).
- `skills` (Skill) - Retrieves the user''s skills. The response will include `skill_ids`, which references the data in the `skills` top-level key. The `skills` data will include the skill description and category ID.
- `work_samples` (WorkSample) - Retrieves the user''s portfolio items. The response will include `work_sample_ids`, which references the data in the `work_samples` top-level key.'
schema:
type: string
- in: query
name: optional_fields
description: Allows you to request one
# --- truncated at 32 KB (88 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mavenlink/refs/heads/main/openapi/mavenlink-users-api-openapi.yml