Features API

The Features API allows you to fetch information about the features in your org, and its limits. These limits may vary depending on your org's edition.

Purpose

To retrieve details of features and its limits for your current org.

Request Details

Request URLs

  • To retrieve all the available features and their corresponding limits:

    {api-domain}/crm/{version}/__features

  • To retrieve a specific feature:

    {api-domain}/crm/{version}/__features?api_names={feature_api_name_1},{feature_api_name_2}

  • To retrieve all the features specific to a module:

    {api-domain}/crm/{version}/__features?module={module_api_name}

  • To retrieve detailed information of a specific feature and its sub-features:

    {api-domain}/crm/{version}/__features/{feature_api_name}

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.features.READ

Parameters

  • modulestring, optional

    To retrieve all available features and their limits for a particular module, specify the module API name of the module.

  • api_namesstring, optional

    Specify the feature api name to retrieve the details and limits specific to that feature. To retrieve details of more than one feature, give the feature api names in comma seperated format.

  • pageinteger, optional

    To get the list of features from the respective pages. Default value for page is 1.
    Possible values: Positive Integer values only.

  • per_pageinteger, optional

    To get the list of features available per page. The default and the maximum possible value is 200.
    Possible values: Positive Integer values only.

  • page_tokenstring, mandatory to fetch more than 2000 services by pagination

    You can use the page param to fetch up to 2000 features without page_token. To fetch more than 2000 features, you must include the page_token param in the request. This param takes the value from the key next_page_token in the response of the first GET features call. This token value is user-specific and if you use another user's token, the system will throw an error.
    The page token is bound to parameters and expires in 24 hours. Also, you cannot use this param with the page param.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v6/__features"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/crm/v6/__features"
	type: GET
	connection:"crm_oauth_connection"
];
info response;

Response JSON Keys

  • componentsJSON Array

    Represents the details of components of a feature.

    • api_namestring

      Represents the api name of the feature.

    • module_supportedboolean

      It represents whether the feature is specific to a module.

    • detailsJSON object

      Contains the details regarding the limits for the feature.

      • limitsJSON object

        It represents the limits related to the feature.

        • edition_limitsinteger

          It represents the a maximum count of the feature allocated for the current edition.

        • totalinteger

          It represents the actual count of the feature allocated to the current org.

  • feature_labelstring

    It represents the feature name in UI. This will be translated to a user's language.

  • parent_featurestring

    It represents the parent feature of the corresponding feature if applicable.

Possible Errors

  • INVALID_REQUEST_METHODHTTP 400

    The http request method type is not a valid one
    Resolution: You have specified an invalid HTTP method to access the API URL.
    Specify a valid request method. Refer to the endpoints section above.

  • INVALID_MODULEHTTP 400

    The module name given seems to be invalid
    Resolution: You have specified an invalid module name.
    Specify a valid module name.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    Unauthorized
    Resolution: Client does not have ZohoCRM.features.READ scope.
    Generate a new token with valid scope. Refer to scope section above for more details.

  • AUTHENTICATION_FAILUREHTTP 401

    Authentication failed
    Resolution: Pass the access token in the request header of the API call.

  • INVALID_URL_PATTERNHTTP 404

    Please check if the URL trying to access is a correct one
    Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to the request URL section above.

  • INTERNAL_ERRORHTTP 500

    Internal Server Error
    Resolution: Unexpected and unhandled exception in the server. Contact support team.

Sample Response

Copied{
    "__features": [
        {
            "components": [
                {
                    "api_name": "custom_field_text",
                    "module_supported": false,
                    "details": {
                        "used_count": {
                            "total": 20
                        },
                        "limits": {
                            "edition_limit": 200,
                            "total": 200
                        }
                    },
                    "feature_label": "Custom Field Text"
                },
                {
                    "api_name": "custom_field_integer",
                    "module_supported": false,
                    "details": {
                        "used_count": {
                            "total": 2
                        },
                        "limits": {
                            "edition_limit": 40,
                            "total": 40
                        }
                    },
                    "feature_label": "Custom Field Integer"
                },
                {
                    "api_name": "custom_field_decimal",
                    "module_supported": false,
                    "details": {
                        "used_count": {
                            "total": 2
                        },
                        "limits": {
                            "edition_limit": 60,
                            "total": 60
                        }
                    },
                    "feature_label": "Custom Field Decimal"
                },
                {
                    "api_name": "custom_field_percentage",
                    "module_supported": false,
                    "details": {
                        "used_count": {
                            "total": 2
                        },
                        "limits": {
                            "edition_limit": 60,
                            "total": 60
                        }
                    },
                    "feature_label": "Custom Field Percentage"
                },
                {
                    "api_name": "custom_field_currency",
                    "module_supported": false,
                    "details": {
                        "used_count": {
                            "total": 2
                        },
                        "limits": {
                            "edition_limit": 60,
                            "total": 60
                        }
                    },
                    "feature_label": "Custom Field Currency"
                },
                {
                    "api_name": "custom_field_date",
                    "module_supported": false,
                    "details": {
                        "used_count": {
                            "total": 2
                        },
                        "limits": {
                            "edition_limit": 50,
                            "total": 50
                        }
                    },
                    "feature_label": "Custom Field Date"
                },
                {
                    "api_name": "custom_field_datetime",
                    "module_supported": false,
                    "details": {
                        "used_count": {
                            "total": 2
                        },
                        "limits": {
                            "edition_limit": 50,
                            "total": 50
                        }
                    },
                    "feature_label": "Custom Field DateTime"
                },
                {
                    "api_name": "custom_field_email",
                    "module_supported": false,
                    "details": {
                        "used_count": {
                            "total": 2
                        },
                        "limits": {
                            "edition_limit": 200,
                            "total": 200
                        }
                    },
                    "feature_label": "Custom Field Email"
                },
                {
                    "api_name": "custom_field_phone",
                    "module_supported": false,
                    "details": {
                        "used_count": {
                            "total": 2
                        },
                        "limits": {
                            "edition_limit": 200,
                            "total": 200
                        }
                    },
                    "feature_label": "Custom Field Phone"
                },
                {
                    "api_name": "custom_field_userlookup",
                    "module_supported": false,
                    "details": {
                        "used_count": {
                            "total": 1
                        },
                        "limits": {
                            "edition_limit": 5,
                            "total": 5
                        }
                    },
                    "feature_label": "Custom Field UserLookup"
                }
            ],
            "api_name": "custom_field",
            "parent_feature": null,
            "module_supported": true,
            "details": {
                "used_count": {
                    "total": 10
                },
                "limits": {
                    "edition_limit": 300,
                    "total": 300
                }
            },
            "feature_label": "Custom Field"
        },
        . 
        . 
        .
    ],
    "info": {
        "per_page": 200,
        "count": 200,
        "page": 1,
        "more_records": true
    }
}