Zoho

Zoho Profile API

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

GitHub OpenAPI

Documentation

📖
Documentation
https://www.zoho.com/crm/developer/docs/api/
📖
APIReference
https://www.zoho.com/crm/developer/docs/api/v8/
📖
GettingStarted
https://www.zoho.com/crm/developer/docs/
📖
Documentation
https://desk.zoho.com/DeskAPIDocument
📖
Documentation
https://www.zoho.com/analytics/api/v2/introduction.html
📖
APIReference
https://www.zoho.com/analytics/api/v2/
📖
Documentation
https://www.bigin.com/developer/docs/apis/v2/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/zoho/refs/heads/main/openapi/zoho-profile-api-openapi.yml

Code Examples

💻
CodeExamples
https://github.com/zoho/ZohoDesk-PortalSDK-Sample-apps-iOS
💻
CodeExamples
https://github.com/zoho/ZohoDesk-PortalSDK-sample-apps-android
💻
CodeExamples
https://github.com/zoho/ZohoDesk-PortalSDK-sample-apps-flutter
💻
CodeExamples
https://github.com/zoho/ZohoDesk-PortalSDK-sample-apps-reactnative
💻
CodeExamples
https://github.com/zoho/Zoho-Desk-ASAP-Mobile-SDK-API-Samples
💻
CodeExamples
https://github.com/zoho/analytics-codestudio

Other Resources

🔗
SDKs
https://packagist.org/packages/zohocrm/php-sdk-8.0
🔗
SDKs
https://pypi.org/project/zohocrmsdk8-0/
🔗
SDKs
https://www.nuget.org/packages/ZOHOCRMSDK-8.0/
🔗
SDKs
https://github.com/zoho/zohocrm-java-sdk-8.0
🔗
SDKs
https://www.npmjs.com/package/@zohocrm/nodejs-sdk-8.0
🔗
SDKs
https://www.npmjs.com/package/@zohocrm/typescript-sdk-8.0
🔗
SDKs
https://rubygems.org/gems/ZOHOCRMSDK8_0
🔗
SDKs
https://github.com/zoho/zohocrm-javascript-sdk-8.0
🔗
SDKs
https://github.com/zoho/zohocrm-scala-sdk-8.0
🔗
SDKs
https://cocoapods.org/pods/ZCRMiOS
🔗
DeveloperPortal
https://www.zoho.com/desk/developers/
🔗
SDKs
https://github.com/zoho/ZohoDeskPortalSDK
🔗
SDKs
https://github.com/zoho/react-native-zohodesk-portal-sdk
🔗
SDKs
https://github.com/zoho/zdesk-asap-flutter
🔗
SDKs
https://github.com/zoho/cordova-plugin-zohodesk-portal
🔗
Tools
https://github.com/zoho/analytics-mcp-server
🔗
Integrations
https://github.com/zoho/analytics-dataiku-import-plugin
🔗
Integrations
https://github.com/zoho/analytics-dataiku-export-plugin
🔗
DeveloperPortal
https://www.bigin.com/developer-center.html

OpenAPI Specification

zoho-profile-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Helpcenter Profile API
  version: 1.0.0
tags:
- name: Profile
paths:
  /api/v1/myProfile:
    get:
      tags:
      - Profile
      summary: Get my profile details
      description: This API fetches the configuration details and permissions defined for the profile of the currently logged in user.
      operationId: getMyProfile
      parameters:
      - $ref: ./Common.json#/components/parameters/orgId
      responses:
        '200':
          $ref: '#/components/responses/commonProfileResponse'
      security:
      - iam-oauth2-schema:
        - Desk.basic.READ
        - Desk.settings.READ
      x-audience:
      - external-public
  /api/v1/profiles/{profileId}:
    get:
      tags:
      - Profile
      summary: Get profile
      description: This API fetches the details of a particular profile.
      operationId: getProfile
      parameters:
      - $ref: '#/components/parameters/profileId'
      - $ref: ./Common.json#/components/parameters/orgId
      responses:
        '200':
          $ref: '#/components/responses/commonProfileResponse'
      security:
      - iam-oauth2-schema:
        - Desk.basic.READ
        - Desk.settings.READ
      x-audience:
      - external-public
    patch:
      tags:
      - Profile
      summary: Update profile
      description: This API updates the details of an existing profile.
      operationId: updateProfile
      parameters:
      - $ref: '#/components/parameters/profileId'
      - $ref: ./Common.json#/components/parameters/orgId
      requestBody:
        $ref: '#/components/requestBodies/profileJson'
      responses:
        '422':
          $ref: ./Common.json#/components/responses/invalidDataErrorResponse
        '200':
          $ref: '#/components/responses/commonProfileResponse'
      security:
      - iam-oauth2-schema:
        - Desk.settings.UPDATE
        - Desk.basic.UPDATE
      x-audience:
      - external-public
  /api/v1/profiles/count:
    get:
      tags:
      - Profile
      summary: Get profile count
      description: This API fetches the number of profiles configured in your help desk.
      operationId: getProfileCount
      parameters:
      - $ref: '#/components/parameters/default'
      - $ref: '#/components/parameters/visible'
      - $ref: ./Common.json#/components/parameters/orgId
      responses:
        '200':
          $ref: '#/components/responses/getProfileCountResponse'
      security:
      - iam-oauth2-schema:
        - Desk.basic.READ
        - Desk.settings.READ
      x-audience:
      - external-public
  /api/v1/lightAgentProfile:
    get:
      tags:
      - Profile
      summary: Get light agent profile
      description: This API fetches the different permissions configured for the light agent profile.
      operationId: getLightAgentProfile
      parameters:
      - $ref: ./Common.json#/components/parameters/orgId
      responses:
        '200':
          $ref: '#/components/responses/commonProfileResponse'
      security:
      - iam-oauth2-schema:
        - Desk.basic.READ
        - Desk.settings.READ
      x-audience:
      - external-public
  /api/v1/profiles/{profileId}/clone:
    post:
      tags:
      - Profile
      summary: Clone profile
      description: This API replicates an existing profile.
      operationId: cloneProfile
      parameters:
      - $ref: '#/components/parameters/profileId'
      - $ref: ./Common.json#/components/parameters/orgId
      requestBody:
        $ref: '#/components/requestBodies/cloneProfileJson'
      responses:
        '422':
          $ref: ./Common.json#/components/responses/invalidDataErrorResponse
        '200':
          $ref: '#/components/responses/commonProfileResponse'
      security:
      - iam-oauth2-schema:
        - Desk.settings.CREATE
        - Desk.basic.CREATE
      x-audience:
      - external-public
  /api/v1/profiles/{profileId}/delete:
    post:
      tags:
      - Profile
      summary: Delete profile
      description: This API deletes a profile from your help desk.
      operationId: deleteProfile
      parameters:
      - $ref: '#/components/parameters/profileId'
      - $ref: ./Common.json#/components/parameters/orgId
      requestBody:
        $ref: '#/components/requestBodies/disableTransfer'
      responses:
        '422':
          $ref: ./Common.json#/components/responses/invalidDataErrorResponse
        '204':
          $ref: ./Common.json#/components/responses/emptyResponse
      security:
      - iam-oauth2-schema:
        - Desk.settings.DELETE
        - Desk.basic.DELETE
      x-audience:
      - external-public
  /api/v1/profiles:
    get:
      tags:
      - Profile
      summary: List profiles
      description: This API lists a particular number of user profiles, based on the limit specified.
      operationId: getProfileList
      parameters:
      - $ref: '#/components/parameters/default'
      - $ref: '#/components/parameters/visible'
      - name: searchStr
        in: query
        description: 'String to search for profile by name or description. The string must contain at least one character. Three search methods are supported: 1) string* - Searches for profiles whose name or description start with the string, 2) *string* - Searches for profiles whose name or description contain the string, 3) string -  Searches for profiles whose name or description is an exact match for the string'
        required: false
        style: form
        explode: true
        schema:
          type:
          - string
          - 'null'
          description: 'String to search for profile by name or description. The string must contain at least one character. Three search methods are supported: 1) string* - Searches for profiles whose name or description start with the string, 2) *string* - Searches for profiles whose name or description contain the string, 3) string -  Searches for profiles whose name or description is an exact match for the string'
          maxLength: 100
          minLength: 0
      - $ref: ./Common.json#/components/parameters/orgId
      responses:
        '200':
          $ref: '#/components/responses/getProfileListResponse'
      security:
      - iam-oauth2-schema:
        - Desk.basic.READ
        - Desk.settings.READ
      x-audience:
      - external-public
  /api/v1/myProfilePermissions:
    get:
      tags:
      - Profile
      summary: Get my profile permissions
      description: This API fetches the permissions associated with the profile of the currently logged in user.
      operationId: getMyProfilePermissions
      parameters:
      - $ref: ./Common.json#/components/parameters/orgId
      responses:
        '200':
          $ref: '#/components/responses/getMyProfilePermissionsResponse'
      security:
      - iam-oauth2-schema:
        - Desk.basic.READ
        - Desk.settings.READ
      x-audience:
      - external-public
  /api/v1/profiles/{profileId}/agents:
    get:
      tags:
      - Profile
      summary: List agents by profile
      description: This API lists agents mapped to a particular profile.
      operationId: getAgentsByProfile
      parameters:
      - name: active
        in: query
        description: Activation status of the agents to list
        required: false
        style: form
        explode: true
        schema:
          type:
          - boolean
          - 'null'
          description: Activation status of the agents to list
      - name: confirmed
        in: query
        description: Confirmation status of the agents to list
        required: false
        style: form
        explode: true
        schema:
          type:
          - boolean
          - 'null'
          description: Confirmation status of the agents to list
      - $ref: '#/components/parameters/profileId'
      - $ref: ./Common.json#/components/parameters/orgId
      responses:
        '204':
          $ref: ./Common.json#/components/responses/emptyResponse
        '200':
          $ref: '#/components/responses/getAgentsResponse'
      security:
      - iam-oauth2-schema:
        - Desk.basic.READ
        - Desk.settings.READ
      x-audience:
      - external-public
components:
  schemas:
    financeIntegPermissionJson:
      type:
      - 'null'
      - object
      additionalProperties: false
      properties:
        sendSalesOrder:
          type:
          - boolean
          - 'null'
        createSalesOrder:
          type:
          - boolean
          - 'null'
        sendInvoice:
          type:
          - boolean
          - 'null'
        viewSubscription:
          type:
          - boolean
          - 'null'
        createEstimate:
          type:
          - boolean
          - 'null'
        createContact:
          type:
          - boolean
          - 'null'
        viewInvoice:
          type:
          - boolean
          - 'null'
        createInvoice:
          type:
          - boolean
          - 'null'
        sendEstimate:
          type:
          - boolean
          - 'null'
        viewSalesOrder:
          type:
          - boolean
          - 'null'
        viewEstimate:
          type:
          - boolean
          - 'null'
      required:
      - createContact
      - createEstimate
      - createInvoice
      - createSalesOrder
      - sendEstimate
      - sendInvoice
      - sendSalesOrder
      - viewEstimate
      - viewInvoice
      - viewSalesOrder
      - viewSubscription
    socialPermissionJson:
      type:
      - 'null'
      - object
      additionalProperties: false
      properties:
        view:
          type:
          - boolean
          - 'null'
        twitterPostDelete:
          type:
          - boolean
          - 'null'
        twitterConversationReply:
          type:
          - boolean
          - 'null'
        twitterPostCreate:
          type:
          - boolean
          - 'null'
      required:
      - twitterConversationReply
      - twitterPostCreate
      - twitterPostDelete
      - view
    kbCategoryPermissionJson:
      type:
      - 'null'
      - object
      additionalProperties: false
      properties:
        view:
          type:
          - boolean
          - 'null'
        editAllArticles:
          type:
          - boolean
          - 'null'
        import:
          type:
          - boolean
          - 'null'
        manageKB:
          type:
          - boolean
          - 'null'
        edit:
          type:
          - boolean
          - 'null'
        admin:
          type:
          - boolean
          - 'null'
        create:
          type:
          - boolean
          - 'null'
        delete:
          type:
          - boolean
          - 'null'
        export:
          type:
          - boolean
          - 'null'
      required:
      - admin
      - create
      - delete
      - edit
      - editAllArticles
      - export
      - import
      - manageKB
      - view
    activitiesPermissionJson:
      type:
      - 'null'
      - object
      additionalProperties: false
      properties:
        manageOwnCustomViews:
          type:
          - boolean
          - 'null'
        shareOwnCustomViews:
          type:
          - boolean
          - 'null'
        editSharedCustomViews:
          type:
          - boolean
          - 'null'
        deleteSharedCustomViews:
          type:
          - boolean
          - 'null'
        reshareSharedCustomViews:
          type:
          - boolean
          - 'null'
      required:
      - deleteSharedCustomViews
      - editSharedCustomViews
      - manageOwnCustomViews
      - reshareSharedCustomViews
      - shareOwnCustomViews
    productsPermissionJson:
      type:
      - 'null'
      - object
      additionalProperties: false
      properties:
        view:
          type:
          - boolean
          - 'null'
        import:
          type:
          - boolean
          - 'null'
        edit:
          type:
          - boolean
          - 'null'
        create:
          type:
          - boolean
          - 'null'
        delete:
          type:
          - boolean
          - 'null'
        export:
          type:
          - boolean
          - 'null'
        manageOwnCustomViews:
          type:
          - boolean
          - 'null'
        shareOwnCustomViews:
          type:
          - boolean
          - 'null'
        editSharedCustomViews:
          type:
          - boolean
          - 'null'
        deleteSharedCustomViews:
          type:
          - boolean
          - 'null'
        reshareSharedCustomViews:
          type:
          - boolean
          - 'null'
      required:
      - create
      - delete
      - deleteSharedCustomViews
      - edit
      - editSharedCustomViews
      - export
      - import
      - manageOwnCustomViews
      - reshareSharedCustomViews
      - shareOwnCustomViews
      - view
    commonProfileResponse:
      type:
      - 'null'
      - object
      additionalProperties: false
      properties:
        default:
          type: boolean
        permissions:
          $ref: '#/components/schemas/commonPermissionJson'
        name:
          type:
          - string
          - 'null'
          maxLength: 50
          minLength: 0
        description:
          type:
          - string
          - 'null'
          maxLength: 32000
          minLength: 0
        isVisible:
          type:
          - boolean
          - 'null'
        id:
          type:
          - string
          - 'null'
          - integer
          format: int64
          pattern: ([0-9]+)
        type:
          type:
          - string
          - 'null'
          enum:
          - Administrator
          - Standard
          - Light
          - Portal
          - Custom
          maxLength: 100
          minLength: 0
      required:
      - default
      - description
      - id
      - isVisible
      - name
      - permissions
      - type
    commentsPermissionJson:
      type:
      - 'null'
      - object
      additionalProperties: false
      properties:
        edit:
          type:
          - boolean
          - 'null'
        delete:
          type:
          - boolean
          - 'null'
      required:
      - delete
      - edit
    mobileappPermissionJson:
      type:
      - 'null'
      - object
      additionalProperties: false
      properties:
        radar:
          type:
          - boolean
          - 'null'
        deskapp:
          type:
          - boolean
          - 'null'
      required:
      - deskapp
      - radar
    agentsPermissionJson:
      type:
      - 'null'
      - object
      additionalProperties: false
      properties:
        overview:
          type:
          - boolean
          - 'null'
        import:
          type:
          - boolean
          - 'null'
        edit:
          type:
          - boolean
          - 'null'
        create:
          type:
          - boolean
          - 'null'
        delete:
          type:
          - boolean
          - 'null'
        viewAllFields:
          type:
          - boolean
          - 'null'
      required:
      - create
      - delete
      - edit
      - import
      - overview
      - viewAllFields
    contractsPermissionJson:
      type:
      - 'null'
      - object
      additionalProperties: false
      properties:
        view:
          type:
          - boolean
          - 'null'
        import:
          type:
          - boolean
          - 'null'
        edit:
          type:
          - boolean
          - 'null'
        create:
          type:
          - boolean
          - 'null'
        delete:
          type:
          - boolean
          - 'null'
        export:
          type:
          - boolean
          - 'null'
        manageOwnCustomViews:
          type:
          - boolean
          - 'null'
        shareOwnCustomViews:
          type:
          - boolean
          - 'null'
        editSharedCustomViews:
          type:
          - boolean
          - 'null'
        deleteSharedCustomViews:
          type:
          - boolean
          - 'null'
        reshareSharedCustomViews:
          type:
          - boolean
          - 'null'
      required:
      - create
      - delete
      - deleteSharedCustomViews
      - edit
      - editSharedCustomViews
      - export
      - import
      - manageOwnCustomViews
      - reshareSharedCustomViews
      - shareOwnCustomViews
      - view
    accountsPermissionJson:
      type:
      - 'null'
      - object
      additionalProperties: false
      properties:
        view:
          type:
          - boolean
          - 'null'
        import:
          type:
          - boolean
          - 'null'
        edit:
          type:
          - boolean
          - 'null'
        create:
          type:
          - boolean
          - 'null'
        delete:
          type:
          - boolean
          - 'null'
        export:
          type:
          - boolean
          - 'null'
        manageOwnCustomViews:
          type:
          - boolean
          - 'null'
        shareOwnCustomViews:
          type:
          - boolean
          - 'null'
        editSharedCustomViews:
          type:
          - boolean
          - 'null'
        deleteSharedCustomViews:
          type:
          - boolean
          - 'null'
        reshareSharedCustomViews:
          type:
          - boolean
          - 'null'
      required:
      - create
      - delete
      - deleteSharedCustomViews
      - edit
      - editSharedCustomViews
      - export
      - import
      - manageOwnCustomViews
      - reshareSharedCustomViews
      - shareOwnCustomViews
      - view
    CommunityCommentPermissionJson:
      type:
      - 'null'
      - object
      additionalProperties: false
      properties:
        view:
          type:
          - boolean
          - 'null'
      required:
      - view
    data:
      type:
      - 'null'
      - array
      items:
        $ref: '#/components/schemas/commonProfileResponse'
    timeEntryPermissionJson:
      type:
      - 'null'
      - object
      additionalProperties: false
      properties:
        view:
          type:
          - boolean
          - 'null'
        edit:
          type:
          - boolean
          - 'null'
        create:
          type:
          - boolean
          - 'null'
        delete:
          type:
          - boolean
          - 'null'
      required:
      - create
      - delete
      - edit
      - view
    crmIntegPermissionJson:
      type:
      - 'null'
      - object
      additionalProperties: false
      properties:
        crmContactsActivityEvents:
          type:
          - boolean
          - 'null'
        crmAccountsActivityEvents:
          type:
          - boolean
          - 'null'
        crmAccountsActivityTasks:
          type:
          - boolean
          - 'null'
        crmAccountsInfo:
          type:
          - boolean
          - 'null'
        crmContactsActivityCalls:
          type:
          - boolean
          - 'null'
        crmAccountsNotes:
          type:
          - boolean
          - 'null'
        crmAccountsActivityCalls:
          type:
          - boolean
          - 'null'
        crmContactsInfo:
          type:
          - boolean
          - 'null'
        crmContactsNotes:
          type:
          - boolean
          - 'null'
        crmContactsActivityTasks:
          type:
          - boolean
          - 'null'
        crmAccountsPotentials:
          type:
          - boolean
          - 'null'
        crmContactsPotentials:
          type:
          - boolean
          - 'null'
      required:
      - crmAccountsActivityCalls
      - crmAccountsActivityEvents
      - crmAccountsActivityTasks
      - crmAccountsInfo
      - crmAccountsNotes
      - crmAccountsPotentials
      - crmContactsActivityCalls
      - crmContactsActivityEvents
      - crmContactsActivityTasks
      - crmContactsInfo
      - crmContactsNotes
      - crmContactsPotentials
    gcPermissionJson:
      type:
      - 'null'
      - object
      additionalProperties: false
      properties:
        view:
          type:
          - boolean
          - 'null'
        edit:
          type:
          - boolean
          - 'null'
        create:
          type:
          - boolean
          - 'null'
        delete:
          type:
          - boolean
          - 'null'
      required:
      - create
      - delete
      - edit
      - view
    contactsPermissionJson:
      type:
      - 'null'
      - object
      additionalProperties: false
      properties:
        view:
          type:
          - boolean
          - 'null'
        import:
          type:
          - boolean
          - 'null'
        edit:
          type:
          - boolean
          - 'null'
        create:
          type:
          - boolean
          - 'null'
        delete:
          type:
          - boolean
          - 'null'
        export:
          type:
          - boolean
          - 'null'
        manageOwnCustomViews:
          type:
          - boolean
          - 'null'
        shareOwnCustomViews:
          type:
          - boolean
          - 'null'
        editSharedCustomViews:
          type:
          - boolean
          - 'null'
        deleteSharedCustomViews:
          type:
          - boolean
          - 'null'
        reshareSharedCustomViews:
          type:
          - boolean
          - 'null'
      required:
      - create
      - delete
      - deleteSharedCustomViews
      - edit
      - editSharedCustomViews
      - export
      - import
      - manageOwnCustomViews
      - reshareSharedCustomViews
      - shareOwnCustomViews
      - view
    radarPermissionJson:
      type:
      - 'null'
      - object
      additionalProperties: false
      properties:
        agentStats:
          type:
          - boolean
          - 'null'
        currentStats:
          type:
          - boolean
          - 'null'
        auditLog:
          type:
          - boolean
          - 'null'
        im:
          type:
          - boolean
          - 'null'
        channelTraffic:
          type:
          - boolean
          - 'null'
        dailyToast:
          type:
          - boolean
          - 'null'
        liveTraffic:
          type:
          - boolean
          - 'null'
        exceptionHandling:
          type:
          - boolean
          - 'null'
        textContentProtection:
          type:
          - boolean
          - 'null'
        dashboards:
          type:
          - boolean
          - 'null'
        dailyTrend:
          type:
          - boolean
          - 'null'
        apiUsageAlerts:
          type:
          - boolean
          - 'null'
        fcr:
          type:
          - boolean
          - 'null'
        activities:
          type:
          - boolean
          - 'null'
        kb:
          type:
          - boolean
          - 'null'
        visualContentProtection:
          type:
          - boolean
          - 'null'
        feeds:
          type:
          - boolean
          - 'null'
        averageHandlingTime:
          type:
          - boolean
          - 'null'
        customerHappiness:
          type:
          - boolean
          - 'null'
        manageRadar:
          type:
          - boolean
          - 'null'
        quickView:
          type:
          - boolean
          - 'null'
        mostThreadedTickets:
          type:
          - boolean
          - 'null'
        contacts:
          type:
          - boolean
          - 'null'
      required:
      - activities
      - agentStats
      - apiUsageAlerts
      - auditLog
      - averageHandlingTime
      - channelTraffic
      - contacts
      - currentStats
      - customerHappiness
      - dailyToast
      - dailyTrend
      - dashboards
      - exceptionHandling
      - fcr
      - feeds
      - im
      - kb
      - liveTraffic
      - manageRadar
      - mostThreadedTickets
      - quickView
      - textContentProtection
      - visualContentProtection
    agentsData:
      type:
      - 'null'
      - array
      items:
        $ref: ./Agent.json#/components/schemas/profileAgentResponse
    ziaPermissionJson:
      type:
      - 'null'
      - object
      additionalProperties: false
      properties:
        view:
          type:
          - boolean
          - 'null'
        edit:
          type:
          - boolean
          - 'null'
        create:
          type:
          - boolean
          - 'null'
        delete:
          type:
          - boolean
          - 'null'
      required:
      - create
      - delete
      - edit
      - view
    chatPermissionJson:
      type:
      - 'null'
      - object
      additionalProperties: false
      properties:
        view:
          type:
          - boolean
          - 'null'
      required:
      - view
    imPermissionJson:
      type:
      - 'null'
      - object
      additionalProperties: false
      properties:
        view:
          type:
          - boolean
          - 'null'
        edit:
          type:
          - boolean
          - 'null'
        create:
          type:
          - boolean
          - 'null'
        delete:
          type:
          - boolean
          - 'null'
      required:
      - create
      - delete
      - edit
      - view
    commonPermissionJson:
      type:
      - 'null'
      - object
      additionalProperties: false
      properties:
        crmInteg:
          $ref: '#/components/schemas/crmIntegPermissionJson'
        reports:
          $ref: '#/components/schemas/reportsPermissionJson'
        tickets:
          $ref: '#/components/schemas/ticketsPermissionJson'
        mobileapp:
          $ref: '#/components/schemas/mobileappPermissionJson'
        contracts:
          $ref: '#/components/schemas/contractsPermissionJson'
        products:
          $ref: '#/components/schemas/productsPermissionJson'
        zia:
          $ref: '#/components/schemas/ziaPermissionJson'
        timeEntry:
          $ref: '#/components/schemas/timeEntryPermissionJson'
        gc:
          $ref: '#/components/schemas/gcPermissionJson'
        tasks:
          $ref: '#/components/schemas/tasksPermissionJson'
        events:
          $ref: '#/components/schemas/contactsPermissionJson'
        courses:
          $ref: '#/components/schemas/clientActionPermissionJson'
        comments:
          $ref: '#/components/schemas/commentsPermissionJson'
        im:
          $ref: '#/components/schemas/imPermissionJson'
        social:
          $ref: '#/components/schemas/socialPermissionJson'
        community:
          $ref: '#/components/schemas/communityPermissionJson'
        agents:
          $ref: '#/components/schemas/agentsPermissionJson'
        CommunityTopic:
          $ref: '#/components/schemas/CommunityTopicPermissionJson'
        radar:
          $ref: '#/components/schemas/radarPermissionJson'
        kbCategory:
          $ref: '#/components/schemas/kbCategoryPermissionJson'
        calls:
          $ref: '#/components/schemas/contactsPermissionJson'
        setup:
          $ref: '#/components/schemas/setupPermissionJson'
        financeInteg:
          $ref: '#/components/schemas/financeIntegPermissionJson'
        CommunityComment:
          $ref: '#/components/schemas/CommunityCommentPermissionJson'
        accounts:
          $ref: '#/components/schemas/accountsPermissionJson'
        contacts:
          $ref: '#/components/schemas/contactsPermissionJson'
        activities:
          $ref: '#/components/schemas/activitiesPermissionJson'
        chat:
          $ref: '#/components/schemas/chatPermissionJson'
        ticketLifeCycleData:
          $ref: '#/components/schemas/ticketLifeCycleDataJson'
        modules:
          type: object
          properties:
            view:
              type: boolean
            edit:
              type: boolean
            create:
              type: boolean
            delete:
              type: boolean
            export:
              type: boolean
            manageOwnCustomViews:
              type:
              - boolean
              - 'null'
            shareOwnCustomViews:
              type:
              - boolean
              - 'null'
            editSharedCustomViews:
              type:
              - boolean
              - 'null'
            deleteSharedCustomViews:
              type:
              - boolean
              - 'null'
            reshareSharedCustomViews:
              type:
              - boolean
              - 'null'
          required:
          - create
          - delete
          - deleteSharedCustomViews
          - edit
          - editSharedCustomViews
          - export
          - manageOwnCustomViews
          - reshareSharedCustomViews
          - shareOwnCustomViews
          - view
        clientEvents:
          $ref: '#/components/schemas/clientActionPermissionJson'
        componentMapping:
          $ref: '#/components/schemas/clientActionPermissionJson'
        eventMapping:
          $ref: '#/components/schemas/clientActionPermissionJson'
        componentEventMappingAssociation:
          $ref: '#/components/schemas/clientActionPermissionJson'
        clientActionConditions:
          $ref: '#/components/schemas/clientActionPermissionJson'
        clientAction:
          $ref: '#/components/schemas/clientActionPermissionJson'
        clientActionModuleAssociation:
          $ref: '#/components/schemas/clientActionPermissionJson'
        clientActionLocationAssociation:
          $ref: '#/components/schemas/clientActionPermissionJson'
      required:
      - CommunityComment
      - CommunityTopic
      - accounts
      - activities
      - agents
      - calls
      - clientAction
      - clientActionConditions
      - clientActionLocationAssociation
      - clientActionModuleAssociation
      - clientEvents
      - comments
      - community
      - componentEventMappingAssociation
      - componentMapping
      - contacts
      - contracts
      - crmInteg
      - eventMapping
      - events
      - financeInteg
      - gc
      - im
      - kbCategory
      - mobileapp
      - products
      - radar
      - reports
      - setup
      - social
      - tasks
      - tickets
      - timeEntry
      - zia
    setupPermissionJson:
      type:
      - 'null'
      - object
      additionalProperties: false
      properties:
        localization:
          type:
          - boolean
          - 'null'
        timeTracking:
          type:
          - boolean
          - 'null'
        massReply:
          type:
          - boolean
          - 'null'
        fetchAcrossDepartment:
          type:
          - boolean
          - 'null'
        globalReports:
          type:
          - boolean
          - 'null'
        exportPortalUsers:
          type:
          - boolean
          - 'null'
        layouts:
          type:
          - boolean
          - 'null'
        shareSnippet:
          type:
          - boolean
          - 'null'
        automation:
          type:
          - boolean
          - 'null'
        featureConfig:
          type:
          - boolean
          - 'null'
        customerHappiness:
          type:
          - boolean
          - 'null'
        department:
          type:
          - boolean
          - 'null'
        portal:
          type:
          - boolean
          - 'null'
        webForm:
          type:
          - boolean
          - 'null'
        rebranding:
          type:
          - boolean
          - 'null'
        email:
          type:
          - boolean
          - 'null'
        recycleBin:
          type:
          - boolean
          - 'null'
        tabsAndFields:
          type:
          - boolean
          - 'null'
        exportUsers:
          type:
          - boolean
          - 'null'
        pinnedConversations:
          type:
          - boolean
          - 'null'
        buttons:
          type:
          - boolean
          - 'null'
        teams:
          type:
          - boolean
          - 'null'
        im:
          type:
          - boolean
          - 'null'
        social:
          type:
          - boolean
          - 'null'
        templates:
          type:
          - boolean
          - 'null'
        sandbox:
          type:
          - boolean
          - 'null'
        securitySettings:
          type:
          - boolean
          - 'null'
        moveRecords:
          type:
          - boolean
          - 'null'
        permission:
          type:
          - boolean
          - 'null'
        signUpApproval:
          type:
          - boolean
          - 'null'
        community:
          ty

# --- truncated at 32 KB (124 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoho/refs/heads/main/openapi/zoho-profile-api-openapi.yml