Get User Licenses Count
Purpose
To retrieve the count of purchased, active and available user licenses in your organization.
Endpoints
Request Details
Request URL
{api-domain}/crm/{version}/__features/user_licenses
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoCRM.features.READ
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v6/__features/user_licenses"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X GETResponse JSON Keys
- detailsJSON object
Represents the details of user licenses.
- available_countJSON object
Indicates the number of user licenses that are available.
- used_countJSON object
Indicates the number of user licenses that are active.
- limitJSON object
Indicates the total number of user licenses purchased.
- componentsJSON object
Represents the details of the components inside a feature. The value will be null for User Licenses feature.
- api_namestring
Represents the api name of the feature.
- parent_featurestring
Represents the parent feature of the feature, if applicable.
- module_supportedboolean
Indicates whether the feature is specific to a module.
- feature_labelstring
Represents the feature name. This will be translated to the user's language.
Sample Response
Copied{
"__features": [
{
"components": null,
"api_name": "user_licenses",
"parent_feature": null,
"module_supported": false,
"details": {
"available_count": {
"total": 3
},
"used_count": {
"total": 7
},
"limits": {
"total": 10
}
},
"feature_label": "UserLicenses"
}
]
}Possible Errors
- 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 request URL section above. - OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution:Refer to scope section above.