Zoho CRM

Zoho CRM Users API

The Users API from Zoho CRM — 10 operation(s) for users.

Documentation GitHub OpenAPI

Operations 18

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /users/{user}/actions/associated_groups List the user groups a user belongs to · Get Associated Groups for User #

Ask an LLM

“Which user groups is a particular CRM user a member of?”

“Can I page through the groups one user is associated with?”

Tell an agent

Show the user groups that user {user} belongs to.

List page {page} of groups associated with user {user}, {per_page} per page.

GET /users List users in the organization · Get users #

Ask an LLM

“How do I get a list of every user in my Zoho CRM organization?”

“Can I filter the org's user list by type, such as active or deactivated users?”

Tell an agent

List all users in my CRM organization.

List CRM users of type {type}.

POST /users Add a new user to the organization · Create User #

Ask an LLM

“How do I add a new teammate as a user in the CRM?”

“What details do I need to invite a new user into my organization?”

Tell an agent

Create a new CRM user with these details: {users}.

Add a new user to our organization.

PUT /users Update several users at once · Update User #

Ask an LLM

“Can I update the details of multiple CRM users in a single request?”

“What's the way to bulk-edit several users' profiles or roles together?”

Tell an agent

Apply these changes to multiple users in one batch: {users}.

Bulk update the listed users' roles and profiles.

GET /users/{user} Get one user's details · Get user #

Ask an LLM

“Where can I look up the profile, role and status of one specific user by ID?”

“What information does the CRM keep about an individual user?”

Tell an agent

Get the details of user {user}.

Show me the role and profile for user ID {user}.

PUT /users/{user} Update a single user by ID · Update User #

Ask an LLM

“Can I change one user's role or profile using their user ID?”

“Is there a way to edit just one user's details without a bulk update?”

Tell an agent

Update user {user} with these changes: {users}.

Change the details of only user {user}.

DELETE /users/{user} Delete a user · Delete a User #

Ask an LLM

“How do I remove a user from the CRM organization for good?”

“Can I delete a user account directly by its ID?”

Tell an agent destructive · confirm first

Delete user {user} from the organization.

Remove CRM user {user}.

GET /users/{user}/territories List territories assigned to a user · Get Territories of User #

Ask an LLM

“Which sales territories are assigned to a given user?”

“Can I see all the territories a rep currently covers?”

Tell an agent

List all territories assigned to user {user}.

Show which territories user {user} covers.

PUT /users/{user}/territories Assign territories to a user · Associate Territories to User #

Ask an LLM

“How do I assign one or more territories to a sales rep?”

“Can I add several territories to a user at the same time?”

Tell an agent

Assign territories {territories} to user {user}.

Associate these territories with user {user}: {territories}.

DELETE /users/{user}/territories Remove several territories from a user · Remove Territories from User #

Ask an LLM

“Can I unassign multiple territories from a user in one call?”

“What's the way to strip a batch of territories off a rep's assignment?”

Tell an agent destructive · confirm first

Remove territories {ids} from user {user}.

Unassign the territories with IDs {ids} from user {user}.

GET /users/{user}/territories/{territory} Get one territory assigned to a user · Get specific Territory of User #

Ask an LLM

“Is a particular territory assigned to a specific user, and what are its details?”

“Can I check one territory assignment for a user rather than listing them all?”

Tell an agent

Show territory {territory} as assigned to user {user}.

Check whether user {user} has territory {territory}.

DELETE /users/{user}/territories/{territory} Remove one territory from a user · Remove Territory from User #

Ask an LLM

“How do I take a single territory away from a user?”

“Can I unassign just one territory from a rep without touching the others?”

Tell an agent destructive · confirm first

Remove territory {territory} from user {user}.

Unassign only territory {territory} from user {user}.

POST /users/{userId}/actions/transfer_and_delete Transfer a user's records and then delete the user · Transfer User #

Ask an LLM

“How do I hand off a departing user's records to someone else and delete their account?”

“Can I transfer a user's assignments and criteria before deleting that specific user?”

Tell an agent destructive · confirm first

Transfer everything owned by user {userId} and then delete them, using {transfer_and_delete}.

Move user {userId}'s records to another user and delete user {userId}.

POST /users/actions/transfer_and_delete Transfer and delete users in a batch · Transfer User #

Ask an LLM

“Can I transfer records from several users and delete all of them in one request?”

“Is there a bulk transfer-and-delete that takes the users in the request body instead of the URL?”

Tell an agent destructive · confirm first

Run a batch transfer-and-delete for these users: {transfer_and_delete}.

Transfer the records of multiple departing users and delete them all: {transfer_and_delete}.

GET /users/actions/transfer_and_delete Check a transfer-and-delete job's status · Get Transfer Status #

Ask an LLM

“Has the job that transfers a user's records and deletes them finished yet?”

“Where do I check progress on a transfer-and-delete job?”

Tell an agent

Check the status of transfer-and-delete job {job_id}.

Tell me whether user deletion job {job_id} has completed.

POST /users/{userId}/actions/transfer Transfer a user's records without deleting them · Transfer User #

Ask an LLM

“Can I reassign a user's records and assignments to someone else but keep the user active?”

“What's the way to move one user's ownership to a colleague without deleting their account?”

Tell an agent

Transfer user {userId}'s records to another user without deleting them, using {transfer}.

Hand over user {userId}'s assignments and criteria but keep the account.

GET /users/actions/transfer Check a transfer-only job's status · Get Transfer Status #

Ask an LLM

“Has my records-only user transfer job (no deletion) finished?”

“Where can I see the progress of a transfer job that keeps the user?”

Tell an agent

Check the status of transfer-only job {job_id}.

Show progress for user transfer job {job_id} that does not delete the user.

GET /users/{userId}/actions/validate_before_transfer Validate a user before transferring them · Get Transfer Status #

Ask an LLM

“Can I check whether a user is ready to be transferred before I start the transfer?”

“Is there a pre-transfer validation I can run on a specific user?”

Tell an agent

Validate user {userId} before transferring their records.

Run the pre-transfer check for user {userId}.

Documentation

https://www.zoho.com/crm/developer/docs/api/v2/notifications/

https://www.zoho.com/crm/developer/docs/api/v8/

https://www.zoho.com/crm/developer/docs/api/v8/list-available-rest-apis.html

Specifications

https://artifacts.apis.io/zoho-crm/openapi/zoho-crm-users-api-openapi.yml

https://artifacts.apis.io/zoho-crm/asyncapi/zoho-crm-notifications-asyncapi.yml

Schemas & Data

https://artifacts.apis.io/zoho-crm/json-schema/zoho-crm-user-details-schema.json

https://artifacts.apis.io/zoho-crm/json-schema/zoho-crm-territory-get-response-schema.json

https://artifacts.apis.io/zoho-crm/json-schema/zoho-crm-success-response-schema.json

https://artifacts.apis.io/zoho-crm/json-schema/zoho-crm-info-schema.json

Other Resources

https://artifacts.apis.io/zoho-crm/asyncapi/zoho-crm-notifications-asyncapi.yml

https://github.com/zoho/crm-oas/blob/main/v8.0/apis.json

https://github.com/zoho/crm-oas/blob/main/v8.0/appointment_preference.json

https://github.com/zoho/crm-oas/blob/main/v8.0/appointments.json

https://github.com/zoho/crm-oas/blob/main/v8.0/assignment_rules.json

https://github.com/zoho/crm-oas/blob/main/v8.0/associate_email.json

https://github.com/zoho/crm-oas/blob/main/v8.0/attachments.json

https://github.com/zoho/crm-oas/blob/main/v8.0/audit_log_export.json

https://github.com/zoho/crm-oas/blob/main/v8.0/available_currencies.json

https://github.com/zoho/crm-oas/blob/main/v8.0/bulk_read.json

https://github.com/zoho/crm-oas/blob/main/v8.0/bulk_write.json

https://github.com/zoho/crm-oas/blob/main/v8.0/business_hours.json

https://github.com/zoho/crm-oas/blob/main/v8.0/cadences_execution.json

https://github.com/zoho/crm-oas/blob/main/v8.0/cadences.json

https://github.com/zoho/crm-oas/blob/main/v8.0/call_preferences.json

https://github.com/zoho/crm-oas/blob/main/v8.0/cancel_meetings.json

https://github.com/zoho/crm-oas/blob/main/v8.0/change_owner.json

https://github.com/zoho/crm-oas/blob/main/v8.0/composite_requests.json

https://github.com/zoho/crm-oas/blob/main/v8.0/contact_roles.json

https://github.com/zoho/crm-oas/blob/main/v8.0/conversion_option.json

https://github.com/zoho/crm-oas/blob/main/v8.0/convert.json

https://github.com/zoho/crm-oas/blob/main/v8.0/coql.json

https://github.com/zoho/crm-oas/blob/main/v8.0/currencies.json

https://github.com/zoho/crm-oas/blob/main/v8.0/custom_views.json

https://github.com/zoho/crm-oas/blob/main/v8.0/data_sharing.json

https://github.com/zoho/crm-oas/blob/main/v8.0/deal_contact_roles.json

https://github.com/zoho/crm-oas/blob/main/v8.0/deal_link_emails.json

https://github.com/zoho/crm-oas/blob/main/v8.0/download_attachments.json

https://github.com/zoho/crm-oas/blob/main/v8.0/download_inline_images.json

https://github.com/zoho/crm-oas/blob/main/v8.0/duplicate_check_preference.json

https://github.com/zoho/crm-oas/blob/main/v8.0/email_drafts.json

https://github.com/zoho/crm-oas/blob/main/v8.0/email_templates.json

https://github.com/zoho/crm-oas/blob/main/v8.0/emails_sharing_details.json

https://github.com/zoho/crm-oas/blob/main/v8.0/features.json

https://github.com/zoho/crm-oas/blob/main/v8.0/fetch_full_data.json

https://github.com/zoho/crm-oas/blob/main/v8.0/field_updates.json

https://github.com/zoho/crm-oas/blob/main/v8.0/fields.json

https://github.com/zoho/crm-oas/blob/main/v8.0/files.json

https://github.com/zoho/crm-oas/blob/main/v8.0/find_and_merge.json

https://github.com/zoho/crm-oas/blob/main/v8.0/fiscal_year.json

https://github.com/zoho/crm-oas/blob/main/v8.0/from_addresses.json

https://github.com/zoho/crm-oas/blob/main/v8.0/get_related_records_count.json

https://github.com/zoho/crm-oas/blob/main/v8.0/global_picklists.json

https://github.com/zoho/crm-oas/blob/main/v8.0/holidays.json

https://github.com/zoho/crm-oas/blob/main/v8.0/inventory_convert.json

https://github.com/zoho/crm-oas/blob/main/v8.0/inventory_templates.json

https://github.com/zoho/crm-oas/blob/main/v8.0/layouts_activate_deactivate.json

https://github.com/zoho/crm-oas/blob/main/v8.0/layouts.json

https://github.com/zoho/crm-oas/blob/main/v8.0/locking_informations.json

https://github.com/zoho/crm-oas/blob/main/v8.0/mail_merge.json

https://github.com/zoho/crm-oas/blob/main/v8.0/map_dependency.json

https://github.com/zoho/crm-oas/blob/main/v8.0/mass_change_owner.json

https://github.com/zoho/crm-oas/blob/main/v8.0/mass_convert.json

https://github.com/zoho/crm-oas/blob/main/v8.0/mass_delete_cvid.json

https://github.com/zoho/crm-oas/blob/main/v8.0/mass_delete_tags.json

https://github.com/zoho/crm-oas/blob/main/v8.0/mass_update.json

https://github.com/zoho/crm-oas/blob/main/v8.0/module_search.json

https://github.com/zoho/crm-oas/blob/main/v8.0/modules.json

https://github.com/zoho/crm-oas/blob/main/v8.0/notes.json

https://github.com/zoho/crm-oas/blob/main/v8.0/notifications.json

https://github.com/zoho/crm-oas/blob/main/v8.0/org.json

https://github.com/zoho/crm-oas/blob/main/v8.0/org_photo.json

https://github.com/zoho/crm-oas/blob/main/v8.0/ownership_history.json

https://github.com/zoho/crm-oas/blob/main/v8.0/pick_list_values.json

https://github.com/zoho/crm-oas/blob/main/v8.0/pipeline.json

https://github.com/zoho/crm-oas/blob/main/v8.0/portal_user_type.json

https://github.com/zoho/crm-oas/blob/main/v8.0/portal_users.json

https://github.com/zoho/crm-oas/blob/main/v8.0/portals.json

https://github.com/zoho/crm-oas/blob/main/v8.0/profiles.json

https://github.com/zoho/crm-oas/blob/main/v8.0/record_count.json

https://github.com/zoho/crm-oas/blob/main/v8.0/record_locking_configurations.json

https://github.com/zoho/crm-oas/blob/main/v8.0/record.json

https://github.com/zoho/crm-oas/blob/main/v8.0/record_photo.json

https://github.com/zoho/crm-oas/blob/main/v8.0/record_share_email.json

https://github.com/zoho/crm-oas/blob/main/v8.0/recycle_bin.json

https://github.com/zoho/crm-oas/blob/main/v8.0/related_lists.json

https://github.com/zoho/crm-oas/blob/main/v8.0/related_notes.json

https://github.com/zoho/crm-oas/blob/main/v8.0/related_records.json

https://github.com/zoho/crm-oas/blob/main/v8.0/roles.json

https://github.com/zoho/crm-oas/blob/main/v8.0/scoring_rules.json

https://github.com/zoho/crm-oas/blob/main/v8.0/send_mail.json

https://github.com/zoho/crm-oas/blob/main/v8.0/service_preference.json

https://github.com/zoho/crm-oas/blob/main/v8.0/services.json

https://github.com/zoho/crm-oas/blob/main/v8.0/share_records.json

https://github.com/zoho/crm-oas/blob/main/v8.0/shift_hours.json

https://github.com/zoho/crm-oas/blob/main/v8.0/tags_actions.json

https://github.com/zoho/crm-oas/blob/main/v8.0/tags.json

https://github.com/zoho/crm-oas/blob/main/v8.0/territories.json

https://github.com/zoho/crm-oas/blob/main/v8.0/territory_users.json

https://github.com/zoho/crm-oas/blob/main/v8.0/timelines.json

https://github.com/zoho/crm-oas/blob/main/v8.0/unblock_email.json

https://github.com/zoho/crm-oas/blob/main/v8.0/unsubscribe_links.json

https://github.com/zoho/crm-oas/blob/main/v8.0/upload.json

https://github.com/zoho/crm-oas/blob/main/v8.0/user_groups.json

https://github.com/zoho/crm-oas/blob/main/v8.0/users.json

https://github.com/zoho/crm-oas/blob/main/v8.0/users_territories.json

https://github.com/zoho/crm-oas/blob/main/v8.0/users_transfer.json

https://github.com/zoho/crm-oas/blob/main/v8.0/variable_groups.json

https://github.com/zoho/crm-oas/blob/main/v8.0/variables.json

https://github.com/zoho/crm-oas/blob/main/v8.0/webhooks.json

https://github.com/zoho/crm-oas/blob/main/v8.0/wizards.json

https://github.com/zoho/crm-oas/blob/main/v8.0/workflow_configurations.json

https://github.com/zoho/crm-oas/blob/main/v8.0/workflow_rules.json

https://github.com/zoho/crm-oas/blob/main/v8.0/workflow_tasks.json

https://github.com/zoho/crm-oas/blob/main/v8.0/zia_enrichment.json

https://github.com/zoho/crm-oas/blob/main/v8.0/zia_org_enrichment.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/zoho-crm:zoho-crm-users-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Zoho Crm Users API
  version: '1.0'
  description: 'Operations tagged Users across 4 of this provider''s published API definitions: zoho-crm-user-groups-openapi.json, zoho-crm-users-openapi.json, zoho-crm-users-territories-openapi.json, zoho-crm-users-transfer-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://zohoapis.{dc}/crm/{version}
  description: API Server URL
  variables:
    dc:
      enum:
      - com
      - eu
      - in
      - cn
      - au
      default: com
      description: API Server URL TLD
    version:
      default: v8
      description: API Version
tags:


# --- truncated at 32 KB (158 KB total) ---
# Full source: https://artifacts.apis.io/zoho-crm/openapi/zoho-crm-users-api-openapi.yml