openapi: 3.1.0
info:
  title: Helpcenter Features API
  version: 1.0.0
tags:
- name: Features
paths:
  /__features:
    get:
      operationId: getFeatureDetails
      summary: Get Feature Details
      description: To get the available feature details for the current edition
      security:
      - iam-oauth2-schema:
        - ZohoCRM.features.READ
      parameters:
      - $ref: '#/components/parameters/Module'
      - $ref: '#/components/parameters/ApiNames'
      - $ref: '#/components/parameters/PerPage'
      - $ref: '#/components/parameters/Page'
      responses:
        '200':
          description: Response of all available features of current edition
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                description: list of available features for the current edition
                properties:
                  __features:
                    description: list of available features for the current edition
                    maxItems: 200
                    type: array
                    items:
                      additionalProperties: true
                      description: list of available features for the current edition
                      type: object
                      properties:
                        api_name:
                          maxLength: 255
                          description: API name of the feature
                          type:
                          - string
                          - 'null'
                        parent_feature:
                          description: Parent feature details
                          type:
                          - object
                          - 'null'
                          properties:
                            api_name:
                              maxLength: 255
                              description: API name of the feature
                              type: string
                          required:
                          - api_name
                        details:
                          description: this object will have limits details
                          type:
                          - object
                          - 'null'
                          properties:
                            available_count:
                              description: availale count details for the feature
                              additionalProperties: false
                              type: object
                              properties:
                                total:
                                  description: total count
                                  type: integer
                                  format: int32
                              required:
                              - total
                            limits:
                              description: availale count details for the feature
                              additionalProperties: false
                              type: object
                              properties:
                                total:
                                  description: total limit
                                  type: integer
                                  format: int32
                                edition_limit:
                                  description: edition limit
                                  type: integer
                                  format: int32
                              required:
                              - total
                            used_count:
                              description: used count of the feature
                              additionalProperties: true
                              type: object
                              properties:
                                total:
                                  description: total count
                                  type: integer
                                  format: int32
                              required:
                              - total
                        components:
                          description: components
                          type:
                          - array
                          - 'null'
                          items:
                            description: components
                            additionalProperties: true
                            type: object
                            properties:
                              api_name:
                                maxLength: 255
                                description: API name of the feature
                                type: string
                              module_supported:
                                description: module wise feature supported or not
                                type: boolean
                              details:
                                description: this object will have limits details
                                type:
                                - object
                                - 'null'
                                properties:
                                  limits:
                                    description: availale count details for the feature
                                    additionalProperties: true
                                    type: object
                                    properties:
                                      total:
                                        description: total limit
                                        type: integer
                                        format: int32
                                      edition_limit:
                                        description: edition limit
                                        type: integer
                                        format: int32
                                    required:
                                    - total
                                  used_count:
                                    description: used count of the feature
                                    additionalProperties: true
                                    type: object
                                    properties:
                                      total:
                                        description: total count
                                        type: integer
                                        format: int32
                                    required:
                                    - total
                                required:
                                - limits
                              feature_label:
                                maxLength: 255
                                description: API name of the feature
                                type: string
                            required:
                            - api_name
                            - module_supported
                            - details
                            - feature_label
                        module_supported:
                          description: module wise feature supported or not
                          type: boolean
                        feature_label:
                          maxLength: 255
                          description: API name of the feature
                          type:
                          - string
                          - 'null'
                      required:
                      - api_name
                      - parent_feature
                      - details
                      - components
                      - module_supported
                      - feature_label
                  info:
                    description: availale count details for the feature
                    additionalProperties: true
                    type: object
                    properties:
                      per_page:
                        description: number of records per page
                        type: integer
                        format: int32
                      count:
                        description: number of features count per page
                        type: integer
                        format: int32
                      page:
                        description: page number
                        type: integer
                        format: int32
                      more_records:
                        description: has more records or not
                        type: boolean
                    required:
                    - per_page
                    - count
                    - page
                    - more_records
                required:
                - __features
        '204':
          description: Feature not available for the current edition
        '400':
          description: Invalid module error response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                description: invalid module error response schema
                properties:
                  status:
                    description: staus of request
                    type: string
                    enum:
                    - error
                  code:
                    description: error code
                    type: string
                    enum:
                    - INVALID_MODULE
                    - INVALID_DATA
                  message:
                    maxLength: 255
                    description: Error message
                    type: string
                  details:
                    additionalProperties: false
                    description: Extra details
                    type: object
                    properties:
                      param_name:
                        maxLength: 25
                        description: Invalid parameter name
                        type: string
                required:
                - status
                - code
                - message
                - details
      tags:
      - Features
  /__features/{feature}:
    get:
      operationId: getFeatureSepcificDetails
      summary: Get Specific Feature Details
      description: To get the available feature specific details for the current edition
      security:
      - iam-oauth2-schema:
        - ZohoCRM.features.READ
      parameters:
      - $ref: '#/components/parameters/Feature'
      - $ref: '#/components/parameters/Module'
      responses:
        '200':
          description: Response of feature specific details of current edition
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                description: specific feature details for the current edition
                properties:
                  __features:
                    description: specific feature details for the current edition
                    maxItems: 1
                    type: array
                    items:
                      additionalProperties: true
                      description: specific feature details for the current edition
                      type: object
                      properties:
                        api_name:
                          maxLength: 255
                          description: API name of the feature
                          type: string
                        parent_feature:
                          description: Parent feature details
                          type:
                          - object
                          - 'null'
                          properties:
                            api_name:
                              maxLength: 255
                              description: API name of the feature
                              type: string
                          required:
                          - api_name
                        details:
                          description: this object will have limits details
                          type:
                          - object
                          - 'null'
                          properties:
                            available_count:
                              description: availale count details for the feature
                              additionalProperties: false
                              type: object
                              properties:
                                total:
                                  description: total count
                                  type: integer
                                  format: int32
                              required:
                              - total
                            limits:
                              description: availale count details for the feature
                              additionalProperties: false
                              type: object
                              properties:
                                total:
                                  description: total limit
                                  type: integer
                                  format: int32
                                edition_limit:
                                  description: edition limit
                                  type: integer
                                  format: int32
                              required:
                              - total
                            used_count:
                              description: used count of the feature
                              additionalProperties: true
                              type: object
                              properties:
                                total:
                                  description: total count
                                  type: integer
                                  format: int32
                              required:
                              - total
                          required:
                          - limits
                        components:
                          description: components
                          type:
                          - array
                          - 'null'
                          items:
                            description: components
                            additionalProperties: true
                            type: object
                            properties:
                              api_name:
                                maxLength: 255
                                description: API name of the feature
                                type: string
                              module_supported:
                                description: module wise feature supported or not
                                type: boolean
                              details:
                                description: this object will have limits details
                                type:
                                - object
                                - 'null'
                                properties:
                                  limits:
                                    description: availale count details for the feature
                                    additionalProperties: true
                                    type: object
                                    properties:
                                      total:
                                        description: total limit
                                        type: integer
                                        format: int32
                                      edition_limit:
                                        description: edition limit
                                        type: integer
                                        format: int32
                                    required:
                                    - total
                                  used_count:
                                    description: used count of the feature
                                    additionalProperties: true
                                    type: object
                                    properties:
                                      total:
                                        description: total count
                                        type: integer
                                        format: int32
                                    required:
                                    - total
                                required:
                                - limits
                              feature_label:
                                maxLength: 255
                                description: API name of the feature
                                type: string
                            required:
                            - api_name
                            - module_supported
                            - details
                            - feature_label
                        module_supported:
                          description: module wise feature supported or not
                          type: boolean
                        feature_label:
                          maxLength: 255
                          description: API name of the feature
                          type:
                          - string
                          - 'null'
                      required:
                      - api_name
                      - parent_feature
                      - details
                      - components
                      - module_supported
                      - feature_label
                required:
                - __features
        '204':
          description: Feature not available for the current edition
        '400':
          description: Invalid module error response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                description: invalid module error response schema
                properties:
                  status:
                    description: staus of request
                    type: string
                    enum:
                    - error
                  code:
                    description: error code
                    type: string
                    enum:
                    - INVALID_MODULE
                    - INVALID_DATA
                  message:
                    maxLength: 255
                    description: Error message
                    type: string
                  details:
                    additionalProperties: false
                    description: Extra details
                    type: object
                required:
                - status
                - code
                - message
                - details
      tags:
      - Features
components:
  parameters:
    ApiNames:
      description: Api names of the feature comma separated
      name: api_names
      in: query
      required: false
      schema:
        type: string
        enum:
        - custom_field
        - custom_field,encrypt_field,unique_field,private_fields,external_field,personal_health_fields
        - personal_health_fields
        - encrypt_field
        - external_field
        - unique_field
        - private_fields
    PerPage:
      description: Per Page Count
      name: per_page
      in: query
      required: false
      schema:
        type: string
        enum:
        - '10'
    Feature:
      description: Feature api name
      name: feature
      in: path
      required: true
      schema:
        maxLength: 25
        type: string
    Module:
      description: module name
      name: module
      in: query
      required: false
      schema:
        maxLength: 25
        type: string
    Page:
      description: Page number
      name: page
      in: query
      required: false
      schema:
        type: string
        enum:
        - '1'
        - '2'
  securitySchemes:
    iam-oauth2-schema:
      $ref: ./Common.json#/components/securitySchemes/iam-oauth2-schema
x-entity: Helpcenter