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 Inventory users API

Users Module

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

This API exposes 1 JSON Schema definition.

Tagged areas include users. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 9 operations across 6 paths, and defines 24 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://www.zohoapis.com/inventory/v1.

9 operations 6 paths 24 schemas 1 DELETE3 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://www.zohoapis.com/inventory/v1
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Zoho Inventory users API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (Zoho_Auth) using the implicit flow, exposing 4 scopes.

Paths & Operations 9

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

users 9

Users Module

POST
/users
Create a user
create_user 1 param body → 200
GET
/users
List Users
list_users 5 params → 200
PUT
/users/{user_id}
Update a user
update_user 2 params body → 200
GET
/users/{user_id}
Get a user
get_user 2 params → 200
DELETE
/users/{user_id}
Delete a user
delete_user 2 params → 200
GET
/users/me
Get current user
get_current_user 1 param → 200
POST
/users/{user_id}/invite
Invite a user
invite_user 2 params → 200
POST
/users/{user_id}/active
Mark user as active
mark_user_as_active 2 params → 200
POST
/users/{user_id}/inactive
Mark user as inactive
mark_user_as_inactive 2 params → 200

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are update-a-user-request (3 properties), get-a-user-response (3 properties), list-users-response (3 properties), create-a-user-request (3 properties). Each schema is shown below with its type and property counts.

mark-user-as-active-response
object
2 properties
status
string
Status of the user, in the project
get-a-user-response
object
3 properties
delete-a-user-response
object
2 properties
create-a-user-request
object
3 properties 2 required
role_id
string
Unique ID of the role, the user is playing
get-current-user-response
object
3 properties
update-a-user-request
object
3 properties 2 required
is_current_user
boolean
to check if user is currently a part of task
name
string
name of the user
is_claimant
boolean
To check if user is a claimant
email
string
email address of the user
list-users-response
object
3 properties
create-a-user-response
object
2 properties
custom_fields
string
Additional fields for task
is_selected
boolean
to check is task is selected
photo_url
string
URL to profile photo of user.
invite-a-user-response
object
2 properties
created_time
string
Time of task creation
user_role
string
The role of the user
user_type
string
Type of user
user_id
string
Unique ID of the user
update-a-user-response
object
2 properties
mark-user-as-inactive-response
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoho-inventory-users-api-openapi.yml Raw ↑

Other APIs Zoho Inventory publishes across the network.

Zoho Inventory batches API
Zoho Inventory bills API
Zoho Inventory compositeitems API
Zoho Inventory contact-persons API
Zoho Inventory contacts API
Zoho Inventory credit-notes API
Zoho Inventory currency API
Zoho Inventory customer-payments API
Zoho Inventory delivery-challans API
Zoho Inventory inventoryadjustments API
Zoho Inventory invoices API
Zoho Inventory itemgroups API