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 Module API

The Module API from Zoho — 5 operation(s) for module.

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

Tagged areas include Module. 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 7 operations across 5 paths, and defines 11 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

7 operations 5 paths 11 schemas 5 GET1 POST1 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 Module API declares 1 security scheme for authenticating requests. It defines a custom scheme (iam-oauth2-schema).

Paths & Operations 7

Across 5 paths, the API surfaces 7 operations — 5 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Module 7
GET
/api/v1/organizationModules/{moduleId}
Get Module
getModule 2 params → 200422500204403
PUT
/api/v1/organizationModules/{moduleId}
Update Module
updateModule 2 params body → 200422500204403
GET
/api/v1/myAccessibleModules
Get Modules Accessible To Current User Profile
getMyModules 1 param → 200
GET
/api/v1/modules
Get modules
getModulesDeprecated 2 params → 200500
GET
/api/v1/organizationModules
Get Modules
getModules 2 params → 500204200
POST
/api/v1/organizationModules
Create Module
createModule 1 param body → 200422500403
GET
/api/v1/{customModuleApiName}/count
Get Custom Module Record Count
getCustomModuleRecordsCount 3 params → 200422500403

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are custommoduleResponseWithNameField (15 properties), moduleJsonIncludingCustomModuleforList (15 properties), modulesWithNameFieldResponse (8 properties), moduleJson (7 properties). Each schema is shown below with its type and property counts.

listOfModulesWithCustomModuleData
nullarray
moduleJson
nullobject
7 properties 7 required
modulesWithNameField
nullarray
listOfModulesIncludingCustomModule
nullarray
listOfModules
nullarray
modulesWithNameFieldResponse
nullobject
8 properties 8 required
moduleJsonIncludingCustomModuleforList
nullobject
15 properties 15 required
modulesWithCustomModuleJson
custommoduleResponseWithNameField
nullobject
15 properties 15 required
modifierJson
nullobject
5 properties 5 required
organizationModuleArrayOfResponses
nullarray

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoho-module-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