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

The Role API from Zoho — 7 operation(s) for role.

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

Tagged areas include Role. 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 9 operations across 7 paths. It is described by OpenAPI 3.1.0, at version 1.0.0.

9 operations 7 paths 0 schemas 6 GET1 PATCH2 POST

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 Role API declares 1 security scheme for authenticating requests. It defines a custom scheme (iam-oauth2-schema).

Paths & Operations 9

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

Role 9
GET
/api/v1/roles/{roleId}
Get role
getRole 2 params → 200
PATCH
/api/v1/roles/{roleId}
Update role
updateRole 2 params body → 422200
GET
/api/v1/rolesByIds
List roles by role IDs
getRolesByIds 2 params → 422204200
GET
/api/v1/personalRole
Get personal role
getPersonalRole 1 param → 200
GET
/api/v1/roles/count
Get role count
getRoleCount 3 params → 200
GET
/api/v1/roles/{roleId}/agents
List agents by role
getAgentsByRole 2 params → 204200
POST
/api/v1/roles/{roleId}/delete
Delete role
deleteRole 2 params body → 422204
GET
/api/v1/roles
List roles
getRoles 6 params → 204200
POST
/api/v1/roles
Create role
addRole 1 param body → 422200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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