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

The Profile API from Zoho — 9 operation(s) for profile.

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

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

10 operations 9 paths 31 schemas 7 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 Profile API declares 1 security scheme for authenticating requests. It defines a custom scheme (iam-oauth2-schema).

Paths & Operations 10

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

Profile 10
GET
/api/v1/myProfile
Get my profile details
getMyProfile 1 param → 200
GET
/api/v1/profiles/{profileId}
Get profile
getProfile 2 params → 200
PATCH
/api/v1/profiles/{profileId}
Update profile
updateProfile 2 params body → 422200
GET
/api/v1/profiles/count
Get profile count
getProfileCount 3 params → 200
GET
/api/v1/lightAgentProfile
Get light agent profile
getLightAgentProfile 1 param → 200
POST
/api/v1/profiles/{profileId}/clone
Clone profile
cloneProfile 2 params body → 422200
POST
/api/v1/profiles/{profileId}/delete
Delete profile
deleteProfile 2 params body → 422204
GET
/api/v1/profiles
List profiles
getProfileList 4 params → 200
GET
/api/v1/myProfilePermissions
Get my profile permissions
getMyProfilePermissions 1 param → 200
GET
/api/v1/profiles/{profileId}/agents
List agents by profile
getAgentsByProfile 4 params → 204200

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are setupPermissionJson (43 properties), commonPermissionJson (38 properties), radarPermissionJson (23 properties), ticketsPermissionJson (23 properties). Each schema is shown below with its type and property counts.

financeIntegPermissionJson
nullobject
11 properties 11 required
socialPermissionJson
nullobject
4 properties 4 required
kbCategoryPermissionJson
nullobject
9 properties 9 required
activitiesPermissionJson
nullobject
5 properties 5 required
productsPermissionJson
nullobject
11 properties 11 required
commonProfileResponse
nullobject
7 properties 7 required
commentsPermissionJson
nullobject
2 properties 2 required
mobileappPermissionJson
nullobject
2 properties 2 required
agentsPermissionJson
nullobject
6 properties 6 required
contractsPermissionJson
nullobject
11 properties 11 required
accountsPermissionJson
nullobject
11 properties 11 required
CommunityCommentPermissionJson
nullobject
1 property 1 required
data
nullarray
timeEntryPermissionJson
nullobject
4 properties 4 required
crmIntegPermissionJson
nullobject
12 properties 12 required
gcPermissionJson
nullobject
4 properties 4 required
contactsPermissionJson
nullobject
11 properties 11 required
radarPermissionJson
nullobject
23 properties 23 required
agentsData
nullarray
ziaPermissionJson
nullobject
4 properties 4 required
chatPermissionJson
nullobject
1 property 1 required
imPermissionJson
nullobject
4 properties 4 required
commonPermissionJson
nullobject
38 properties 34 required
setupPermissionJson
nullobject
43 properties 43 required
clientActionPermissionJson
nullobject
10 properties 10 required
ticketLifeCycleDataJson
nullobject
10 properties 10 required
tasksPermissionJson
nullobject
11 properties 11 required
reportsPermissionJson
nullobject
5 properties 5 required
CommunityTopicPermissionJson
nullobject
1 property 1 required
communityPermissionJson
nullobject
5 properties 5 required
ticketsPermissionJson
nullobject
23 properties 23 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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