Zoho Records API is one of 205 APIs that Zoho publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Records. 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
8 operations
across 3 paths,
and defines 10 schemas.
It is described by OpenAPI 3.1.0, at version 1.0.0.
8 operations3 paths10 schemas2 DELETE3 GET1 POST2 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 Records API declares
1 security scheme
for authenticating requests.
It defines a custom scheme (iam-oauth2-schema).
Paths & Operations 8
Across 3 paths, the API surfaces 8 operations — 2 DELETE, 3 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Records 8
GET
/{moduleApiName}/actions/count
Get Record Count in a Module
getCount11 params→ 200400401500
GET
/{module}
Get Records for a specific module
getRecords12 params→ 200204400403404500
POST
/{module}
Create a Record in a specific module
createRecords1 parambody→ 201400401403404500
PUT
/{module}
To update existing entities or records in a specified module
updateRecords1 parambody→ 200400401403404412500
DELETE
/{module}
Delete multiple records from a module
deleteRecords2 params→ 200207400401403404500
GET
/{module}/{recordID}
Get Record for a specific module with RecordId
getRecord2 params→ 200204400403404500
PUT
/{module}/{recordID}
To update existing entities or records in a specified module with the recordID
updateRecord2 paramsbody→ 200400401403404412500
DELETE
/{module}/{recordID}
Delete a single record by ID
deleteRecord2 params→ 200400401403404500
Schemas 10
The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are RecordsInputSchema (4 properties), ErrorResponse (4 properties), RecordGETSucessResponse (2 properties), RecordSuccessResponse (1 property). Each schema is shown below with its type and property counts.
ErrorResponse
object
A standard error response from the Zoho CRM API.
4 properties
RecordUnathorizedResponse
object
Response schema returned when a request is unauthorized due to OAuth scope mismatches.
1 property
RecordInternalErrorResponse
object
Schema for internal server error responses related to record operations.
1 property
RecordInvalidURLResponse
object
Response schema returned when the requested API endpoint URL pattern is invalid or unsupported.
1 property
RecordGETErrorResponse
object
Error response schema returned when GET record or GET records operations fail due to validation, pagination, or processing errors.
1 property
RecordsErrorResponse
object
Standard error response schema returned when one or more record operations fail.
1 property
RecordGETSucessResponse
object
Successful response schema returned for GET record or GET records API operations.
2 properties
RecordSuccessResponse
object
Standard success response schema for single or bulk record operations.
1 property1 required
RecordsInputSchema
object
Input schema for create, update, or upsert record requests.
4 properties1 required
RecordPermissionResponse
object
Response schema returned when a user lacks the necessary permissions to perform a record operation.
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
