Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zoho Users API

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

Zoho Users API is one of 205 APIs that Zoho publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Users. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and code examples.

This API exposes 18 operations across 10 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

18 operations 10 paths 6 schemas 3 DELETE8 GET4 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Authentication
custom
Resource Areas
1

Authentication & Security 1

Zoho Users API declares 1 security scheme for authenticating requests. It defines a custom scheme (iam-oauth2-schema).

Paths & Operations 18

Across 10 paths, the API surfaces 18 operations — 3 DELETE, 8 GET, 4 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 18
POST
/users/{userId}/actions/transfer_and_delete
Transfer User
userTransfer 1 param body → 200400403
POST
/users/actions/transfer_and_delete
Transfer User
userTransferWithoutId body → 200400403
GET
/users/actions/transfer_and_delete
Get Transfer Status
getTransferStatus 1 param → 200204400
POST
/users/{userId}/actions/transfer
Transfer User
userTransferAPI 1 param body → 201400403
GET
/users/actions/transfer
Get Transfer Status
getTransferAPIStatus 1 param → 200204400
GET
/users/{userId}/actions/validate_before_transfer
Get Transfer Status
getValidateBeforeTransferStatus 1 param → 200400
GET
/users/{user}/actions/associated_groups
Get Associated Groups for User
getAssociatedGroupsForUser 4 params → 200400404
GET
/users/{user}/territories
Get Territories of User
getTerritoriesOfUser 1 param → 200204400
PUT
/users/{user}/territories
Associate Territories to User
associateTerritoriesToUser 1 param body → 200400403
DELETE
/users/{user}/territories
Remove Territories from User
removeTerritoriesfromUser 2 params → 200400
GET
/users/{user}/territories/{territory}
Get specific Territory of User
getSpecificTerritoryOfUser 2 params → 200204400
DELETE
/users/{user}/territories/{territory}
Remove Territory from User
removeSpecificTerritoriesfromUser 2 params → 200400
GET
/users
Get users
getUsers 4 params → 200204
POST
/users
Create User
createUser body → 201400403
PUT
/users
Update User
updateUser body → 200400403
GET
/users/{user}
Get user
getSingleUser 1 param → 200204
PUT
/users/{user}
Update User
updateSingleUser 1 param body → 200400403
DELETE
/users/{user}
Delete a User
deleteUser 1 param → 200400403

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are UserDetails (54 properties), Info (4 properties), CommonUrlErrorResponse (4 properties), TerritoryGetResponse (2 properties). Each schema is shown below with its type and property counts.

TerritoryGetResponse
object
Response schema for getting territories of a user
2 properties 2 required
SuccessResponse
object
Response for successful association of territories to a user
1 property 1 required
CommonErrorResponse
object
Response containing an array of per-territory error items
1 property 1 required
CommonUrlErrorResponse
object
Error response for INVALIDDATA that includes a resourcepathindex in details
4 properties 3 required
UserDetails
object
User details
54 properties
Info
object
Pagination information
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoho-users-api-openapi.yml Raw ↑

Other APIs Zoho publishes across the network.

Zoho Inventory
Zoho Books
Zoho Invoice
Zoho Billing
Zoho Expense
Zoho People
Zoho Recruit
Zoho Projects
Zoho Mail
Zoho Sign
Zoho Campaigns
Zoho SalesIQ