API Quick Reference: Managing Users – Kantata Knowledge Base

Default Account Permissions: Account Administrator

This article provides a list of endpoints for managing users to help you get started with the API. For the full documentation, see the Kantata OX API Documentation.

Action	Endpoint
Get all active users on account	Get users endpoint - use the `on_my_account` filter to include users who may not be in projects
Get all inactive users on account	Get account memberships endpoint - use the `only_inactive` filter and `include=user` option
Create a user	Create account invitation endpoint
Update account member information—such as cost rate, manager, account permission, or account role for a user—which correspond to fields in the Account Member side panel	Update account membership endpoint
Update user profile information—user’s name, headline, or email address	Update user endpoint
Update user’s custom fields	Create custom field value endpoint or update custom field value endpoint
Update user profile photo	Update user profile photo endpoint
Deactivate a user	Deactivate account membership endpoint
Reactivate a user	Activate account membership endpoint
Add user to access group	Create access group membership endpoint
Remove user from access group	Delete access group membership endpoint

NOTE

For the endpoints to update, deactivate, or reactivate a user, you will need either the account membership ID or user ID. You can get these from the get account memberships endpoint:

GET https://api.mavenlink.com/api/v1/account_memberships?include=user&search={name}

Related Articles