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

The Department API from Zoho — 11 operation(s) for department.

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

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

15 operations 11 paths 3 schemas 1 DELETE7 GET1 PATCH6 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 Department API declares 1 security scheme for authenticating requests. It defines a custom scheme (iam-oauth2-schema).

Paths & Operations 15

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

Department 15
POST
/api/v1/departments/{departmentId}/associateAgents
Associate agents to department
associateAgentsToDepartment 2 params body → 422204
GET
/api/v1/departments/{departmentId}
Get department
getDepartment 2 params → 200
PATCH
/api/v1/departments/{departmentId}
Update department
updateDepartment 2 params body → 200422
GET
/api/v1/departments/{departmentId}/logo
Get department logo
getDepartmentLogo 3 params → 200
POST
/api/v1/departments/{departmentId}/logo
Upload department logo
updateDepartmentLogo 2 params body → 422204
DELETE
/api/v1/departments/{departmentId}/logo
Delete department logo
deleteDepartmentLogo 2 params → 204
POST
/api/v1/departments/{departmentId}/enable
Enable department
enableDepartment 2 params → 204
POST
/api/v1/departments/{departmentId}/disable
Disable department
disableDepartment 2 params body → 422204
GET
/api/v1/departmentsByIds
Get department details by department IDs
getDepartmentsByIds 2 params → 422204200
GET
/api/v1/departments/{departmentId}/agents
List agents in department
getAgentsInDepartment 10 params → 204200
GET
/api/v1/departments/count
Get department count
getDepartmentsCount 1 param → 200
POST
/api/v1/departments/{departmentId}/dissociateAgents
Dissociate agents from department
dissociateAgents 2 params body → 422204
GET
/api/v1/departments
List departments
getDepartments 6 params → 204200
POST
/api/v1/departments
Add department
addDepartment 1 param body → 422200
GET
/api/v1/departments/checkExists
Check for duplicate departments
checkDepartmentNameExist 2 params → 422200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are commonDepartmentResponse (13 properties), updateDepartmentJson (2 properties). Each schema is shown below with its type and property counts.

commonDepartmentResponse
nullobject
13 properties 13 required
updateDepartmentJson
nullobject
2 properties 2 required
data
nullarray

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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