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 Account Memberships 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: Account Memberships
description: 'Each user on an account will have an account membership that describes their relationship to the account. When you add a user
to an account, create a new `account_membership`. When you remove a user from an account, delete their account_membership record.'
paths:
/account_memberships:
get:
summary: Fetching a list of Account Memberships
description: 'You can request either GET /api/v1/account_memberships.json?only=5 or
GET /api/v1/account_memberships/5.json. In both cases, default filters will be applied.
Unless you provide the is_active:false filter, you won''t receive account membership for inactive users, and will get a 404 status
on the "show" route.
This endpoint returns structured Account Membership 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 `account_memberships` top-level JSON key.
Please see our Response Format section for more information.'
operationId: Get Account Memberships
tags:
- Account Memberships
parameters:
- in: query
name: by_full_name
description: Search account memberships by full name of the user.
schema:
type: string
- in: query
name: by_user_id
description: Only includes account membership for the specified user ID.
schema:
type: integer
format: int32
- in: query
name: can_log_in
description: Return account memberships based on whether or not the member is allowed to login.
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: include
description: 'Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.
- `backup_approver_associations` (BackupApproverAssociation) - Retrieves the [backup approver associations](/tag/Backup-Approver-Associations) for the user this account membership is for, which represent a backup time approver for a specific date range. The response will include `backup_approver_association_ids`, which references the data in the `backup_approver_associations` top-level key.
- `cost_rates` (CostRate) - Retrieves all the cost rates in different currencies for the user this account membership is for. The response will include `cost_rate_ids`, which references the data in the `cost_rates` top-level key.
- `default_role` (Role) - Retrieves the default role, if any, for this account membership. The response will include `default_role_id`, which references the data in the `roles` top-level key.
- `effective_workweek` (Workweek) - Retrieves the workweek that is in effect today for the user this account membership is for. The response will include `effective_workweek_id`, which references the data in the `workweeks` top-level key.
- `future_billable_utilizations` (BillableUtilization) - Retrieves the future billable utilizations for the user this account membership is for. The response will include `future_billable_utilization_ids`, which references the data in the `billable_utilizations` top-level key.
- `managees` (User) - Retrieves the direct reports of the user this account membership is for. The response will include `managee_ids`, which references the data in the `users` top-level key.
- `manager` (User) - Retrieves the manager of the user this account membership is for. The response will include `manager_id`, which references the data in the `users` top-level key.
- `possible_managees` (User) - Retrieves a list of users who can become the direct reports of the user this account membership is for. The response will include `possible_managee_ids`, which references the data in the `users` top-level key.
- `possible_managers` (User) - Retrieves a list of users who can be set as the manager of the user this account membership is for. The response will include `possible_manager_ids`, which references the data in the `users` top-level key.
- `skill_memberships` (SkillMembership) - Retrieves the skill memberships for the user this account membership is for, which represent skills assigned to a user. The response will include `skill_membership_ids`, which references the data in the `skill_memberships` top-level key.
- `user` (User) - Retrieves the user for this account membership. The response will include `user_id`, which references the data in the `users` top-level key.'
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_active
description: Only includes users with an active membership (disabled_at is null).
schema:
type: boolean
- in: query
name: only_inactive
description: Only includes users with an inactive membership (disabled_at is not null).
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:
- can_log_in
- non_participant
- in: query
name: order
description: 'Supply `order` with the name of a valid sort field for the endpoint and a direction.
Valid values: `bill_rate:asc`, `bill_rate:desc`, `cost_rate:asc`, `cost_rate:desc`, `created_at:asc`, `created_at:desc`, `full_name:asc`, `full_name:desc`, `permission:asc`, `permission:desc`, `role:asc`, `role:desc`, `updated_at:asc`, and `updated_at:desc`.'
schema:
type: string
default: created_at:desc
- in: query
name: page
schema:
type: integer
format: int32
default: 1
- in: query
name: per_page
schema:
type: integer
format: int32
default: 20
maximum: 200
- in: query
name: search
schema:
type: string
- 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_skills
required: false
description: 'Return only account memberships for users with the specified skills and levels. Provide the skill IDs,
level numbers for each skill (if applicable), and whether to filter using AND or OR logic.
You can specify multiple skills and multiple levels.
Format as `{"ids":[skill_id,skill_id],"skill_id":[level,level],"skill_id":[level],"operation":"<or/and>"}` .
Example 1 - Filter by two skills, one which has levels and one which doesn''t. Apply AND logic.
`{"ids":[234,789],"234":[3,4],"operation":"and"}`
Example 2 - Filter by two skills, both of which have levels. Apply OR logic.
`{"ids":[123,456],"123":[4,5],"456":[1,2],"operation":"or"}`.'
schema:
type: string
- in: query
name: with_user_ids
description: Only includes account memberships for the specified user IDs. For example, '1,2,3'.
schema:
type: string
responses:
'200':
description: A list of Account Memberships 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
account_memberships:
type: object
additionalProperties:
$ref: '#/components/schemas/AccountMembership'
users:
type: object
additionalProperties:
$ref: '#/components/schemas/User'
roles:
type: object
additionalProperties:
$ref: '#/components/schemas/Role'
workweeks:
type: object
additionalProperties:
$ref: '#/components/schemas/Workweek'
skill_memberships:
type: object
additionalProperties:
$ref: '#/components/schemas/SkillMembership'
backup_approver_associations:
type: object
additionalProperties:
$ref: '#/components/schemas/BackupApproverAssociation'
cost_rates:
type: object
additionalProperties:
$ref: '#/components/schemas/CostRate'
billable_utilizations:
type: object
additionalProperties:
$ref: '#/components/schemas/BillableUtilization'
'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'
/account_memberships/{id}:
get:
summary: Fetching a single Account Membership
description: 'This endpoint returns structured Account Membership 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 `account_memberships` top-level JSON key.
Please see our Response Format section for more information.'
operationId: Get Account Membership
tags:
- Account Memberships
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`.
- `backup_approver_associations` (BackupApproverAssociation) - Retrieves the [backup approver associations](/tag/Backup-Approver-Associations) for the user this account membership is for, which represent a backup time approver for a specific date range. The response will include `backup_approver_association_ids`, which references the data in the `backup_approver_associations` top-level key.
- `cost_rates` (CostRate) - Retrieves all the cost rates in different currencies for the user this account membership is for. The response will include `cost_rate_ids`, which references the data in the `cost_rates` top-level key.
- `default_role` (Role) - Retrieves the default role, if any, for this account membership. The response will include `default_role_id`, which references the data in the `roles` top-level key.
- `effective_workweek` (Workweek) - Retrieves the workweek that is in effect today for the user this account membership is for. The response will include `effective_workweek_id`, which references the data in the `workweeks` top-level key.
- `future_billable_utilizations` (BillableUtilization) - Retrieves the future billable utilizations for the user this account membership is for. The response will include `future_billable_utilization_ids`, which references the data in the `billable_utilizations` top-level key.
- `managees` (User) - Retrieves the direct reports of the user this account membership is for. The response will include `managee_ids`, which references the data in the `users` top-level key.
- `manager` (User) - Retrieves the manager of the user this account membership is for. The response will include `manager_id`, which references the data in the `users` top-level key.
- `possible_managees` (User) - Retrieves a list of users who can become the direct reports of the user this account membership is for. The response will include `possible_managee_ids`, which references the data in the `users` top-level key.
- `possible_managers` (User) - Retrieves a list of users who can be set as the manager of the user this account membership is for. The response will include `possible_manager_ids`, which references the data in the `users` top-level key.
- `skill_memberships` (SkillMembership) - Retrieves the skill memberships for the user this account membership is for, which represent skills assigned to a user. The response will include `skill_membership_ids`, which references the data in the `skill_memberships` top-level key.
- `user` (User) - Retrieves the user for this account membership. The response will include `user_id`, which references the data in the `users` 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:
- can_log_in
- non_participant
responses:
'200':
description: The Account Membership 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
account_memberships:
type: object
additionalProperties:
$ref: '#/components/schemas/AccountMembership'
users:
type: object
additionalProperties:
$ref: '#/components/schemas/User'
roles:
type: object
additionalProperties:
$ref: '#/components/schemas/Role'
workweeks:
type: object
additionalProperties:
$ref: '#/components/schemas/Workweek'
skill_memberships:
type: object
additionalProperties:
$ref: '#/components/schemas/SkillMembership'
backup_approver_associations:
type: object
additionalProperties:
$ref: '#/components/schemas/BackupApproverAssociation'
cost_rates:
type: object
additionalProperties:
$ref: '#/components/schemas/CostRate'
billable_utilizations:
type: object
additionalProperties:
$ref: '#/components/schemas/BillableUtilization'
'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 Account Membership
description: 'This endpoint returns structured Account Membership 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 `account_memberships` top-level JSON key.
Please see our Response Format section for more information.'
operationId: Update Account Membership
tags:
- Account Memberships
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`.
- `backup_approver_associations` (BackupApproverAssociation) - Retrieves the [backup approver associations](/tag/Backup-Approver-Associations) for the user this account membership is for, which represent a backup time approver for a specific date range. The response will include `backup_approver_association_ids`, which references the data in the `backup_approver_associations` top-level key.
- `cost_rates` (CostRate) - Retrieves all the cost rates in different currencies for the user this account membership is for. The response will include `cost_rate_ids`, which references the data in the `cost_rates` top-level key.
- `default_role` (Role) - Retrieves the default role, if any, for this account membership. The response will include `default_role_id`, which references the data in the `roles` top-level key.
- `effective_workweek` (Workweek) - Retrieves the workweek that is in effect today for the user this account membership is for. The response will include `effective_workweek_id`, which references the data in the `workweeks` top-level key.
- `future_billable_utilizations` (BillableUtilization) - Retrieves the future billable utilizations for the user this account membership is for. The response will include `future_billable_utilization_ids`, which references the data in the `billable_utilizations` top-level key.
- `managees` (User) - Retrieves the direct reports of the user this account membership is for. The response will include `managee_ids`, which references the data in the `users` top-level key.
- `manager` (User) - Retrieves the manager of the user this account membership is for. The response will include `manager_id`, which references the data in the `users` top-level key.
- `possible_managees` (User) - Retrieves a list of users who can become the direct reports of the user this account membership is for. The response will include `possible_managee_ids`, which references the data in the `users` top-level key.
- `possible_managers` (User) - Retrieves a list of users who can be set as the manager of the user this account membership is for. The response will include `possible_manager_ids`, which references the data in the `users` top-level key.
- `skill_memberships` (SkillMembership) - Retrieves the skill memberships for the user this account membership is for, which represent skills assigned to a user. The response will include `skill_membership_ids`, which references the data in the `skill_memberships` top-level key.
- `user` (User) - Retrieves the user for this account membership. The response will include `user_id`, which references the data in the `users` 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:
- can_log_in
- non_participant
responses:
'200':
description: Account Membership 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
account_memberships:
type: object
additionalProperties:
$ref: '#/components/schemas/AccountMembership'
users:
type: object
additionalProperties:
$ref: '#/components/schemas/User'
roles:
type: object
additionalProperties:
$ref: '#/components/schemas/Role'
workweeks:
type: object
additionalProperties:
$ref: '#/components/schemas/Workweek'
skill_memberships:
type: object
additionalProperties:
$ref: '#/components/schemas/SkillMembership'
backup_approver_associations:
type: object
additionalProperties:
$ref: '#/components/schemas/BackupApproverAssociation'
cost_rates:
type: object
additionalProperties:
$ref: '#/components/schemas/CostRate'
billable_utilizations:
type: object
additionalProperties:
$ref: '#/components/schemas/BillableUtilization'
'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:
account_membership:
type: object
properties:
bill_rate_in_cents:
type: integer
format: int32
description: The default billing rate, in cents, for the user in a workspace on this account.
cost_rate_in_cents:
type: integer
format: int32
description: The default cost rate, in cents, for the user in a workspace on this account.
default_role_id:
type: integer
format: int32
description: The internal ID for the role of this user on this account.
permission:
type: string
description: The user's permission level on the account. Valid values are 'administrator', 'reports_viewer', 'reports_viewer_with_cost', 'project_lead', 'project_creator', 'punch_clock', 'external_collaborator' or 'collaborator'.
billability_target:
type: integer
format: int32
description: Value for setting the user's billability target.
default_read_only:
type: boolean
description: Whether the user is always read-only in workspaces.
manager_id:
type: integer
format: int32
description: The User ID of the user's manager.
manager_can_approve:
type: boolean
description: Whether the user's named manager can approve their time and expenses.
manager_can_edit_skills:
type: boolean
description: Whether the user's named manager can edit their skills.
should_show_alert_on_timesheet_submission:
type: boolean
description: Show an alert on a user's timesheet.
change_role_option:
type: string
description: Select 'update_with_new_role', 'add_another_role', or 'keep_existing_role'. If no option is selected another role will be added.
enforce_workweek_minimum_on_timesheet_submission:
type: boolean
description: If true, the user is required to submit timesheets equal to or greater than their workweek hours.
enforce_workweek_maximum_on_timesheet_submission:
type: boolean
description: If true, the user is required to submit timesheets equal to or less than their workweek hours.
required: true
delete:
summary: Remove a user from an account
description: 'This removes the member from your account and places them on a separate Kantata OX account. It is important
to know that the account owner cannot be removed.
**WARNING:** Since the removed member gets their on own separate Kantata OX account,
they will remain on existing projects but will be View Only and no
longer be able to create projects in your account.
We suggest `disabling` an account member over removing them since it revokes their ability to access
your account and they will no longer have access to projects for which they were contributing.
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 Account Membership
tags:
- Account Memberships
parameters:
- in: path
name: id
required: true
description: The ID of the Model.
schema:
type: integer
responses:
'204':
description: Account Membership 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/Er
# --- truncated at 32 KB (70 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mavenlink/refs/heads/main/openapi/mavenlink-account-memberships-api-openapi.yml