Zoho: Features
Zoho features.getFeatureDetails: arguments, response, policy and SDK examples.
← Features operations · Get started
Operation zoho.getfeaturedetails
Provider route: GET /crm/v8/__features. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { ZohoIntegration } from "@alter-ai/zoho";
async function execute(input: Parameters<ZohoIntegration["features"]["getFeatureDetails"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.features.getFeatureDetails(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_zoho import ZohoIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.features.get_feature_details(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.module | string | Optional | Maximum length: 25 |
query.api_names | string | Optional | One of: 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 |
query.per_page | string | Optional | One of: 10 |
query.page | string | Optional | One of: 1, 2 |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | Represents the response structure for a successful feature list retrieval, containing the array of available features and pagination metadata. Additional keys: allowed |
$ (anyOf 1).__features | array | Required within parent | Represents the list of feature objects available for the current edition. Always returned in the response. Maximum items: 200 |
$ (anyOf 1).__features[] | object | Each item | Represents a single feature object, including its API name, module support status, usage limits, consumption details, and sub-feature components. Additional keys: allowed |
$ (anyOf 1).__features[].api_name | JSON | Required within parent | |
$ (anyOf 1).__features[].api_name (anyOf 1) | string | Alternative | Represents the unique API identifier for the feature, such as custom_field or encrypt_field. Always returned in the response. Maximum length: 255 |
$ (anyOf 1).__features[].api_name (anyOf 2) | null | Alternative | Represents the unique API identifier for the feature, such as custom_field or encrypt_field. Always returned in the response. Maximum length: 255 |
$ (anyOf 1).__features[].components | JSON | Required within parent | |
$ (anyOf 1).__features[].components (anyOf 1) | array | Alternative | Represents the list of sub-feature components for the feature. Each component includes its own API name, module support flag, and usage limit details. Always returned in the response. Maximum items: 200 |
$ (anyOf 1).__features[].components (anyOf 1)[] | Model | Each item | Expand Features — response body — features, info features item components null item |
$ (anyOf 1).__features[].components (anyOf 2) | null | Alternative | Represents the list of sub-feature components for the feature. Each component includes its own API name, module support flag, and usage limit details. Always returned in the response. Maximum items: 200 |
$ (anyOf 1).__features[].components (anyOf 2)[] | Model | Each item | Expand Features — response body — features, info features item components null item |
$ (anyOf 1).__features[].details | JSON | Required within parent | |
$ (anyOf 1).__features[].details (anyOf 1) | object | Alternative | Represents the limits and usage details for the feature, including available count, usage limits, and current consumption. Always returned in the response. |
$ (anyOf 1).__features[].details (anyOf 1).available_count | object | Optional | Represents the number of feature instances available for use in the organization. Additional keys: not allowed |
$ (anyOf 1).__features[].details (anyOf 1).available_count.total | JSON | Required within parent | |
$ (anyOf 1).__features[].details (anyOf 1).available_count.total (anyOf 1) | integer | Alternative | Represents the total number of available instances for the feature. Always returned in the response. Format: int32 |
$ (anyOf 1).__features[].details (anyOf 1).available_count.total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).__features[].details (anyOf 1).limits | Model | Optional | Expand Features — response body — features, info features item details available count, limits, used count limits |
$ (anyOf 1).__features[].details (anyOf 1).used_count | JSON | Optional | Represents the used count of the feature |
$ (anyOf 1).__features[].details (anyOf 1).used_count (anyOf 1) | object | Alternative | Represents the used count of the feature Additional keys: allowed |
$ (anyOf 1).__features[].details (anyOf 1).used_count (anyOf 1).total | JSON | Required within parent | |
$ (anyOf 1).__features[].details (anyOf 1).used_count (anyOf 1).total (anyOf 1) | integer | Alternative | Represents the total count Format: int32 |
$ (anyOf 1).__features[].details (anyOf 1).used_count (anyOf 1).total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).__features[].details (anyOf 1).used_count (anyOf 2) | JSON | Alternative | |
$ (anyOf 1).__features[].details (anyOf 1).used_count (anyOf 2) (anyOf 1) | integer | Alternative | Represents the used count of the feature Format: int32 |
$ (anyOf 1).__features[].details (anyOf 1).used_count (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).__features[].details (anyOf 2) | null | Alternative | Represents the limits and usage details for the feature, including available count, usage limits, and current consumption. Always returned in the response. |
$ (anyOf 1).__features[].details (anyOf 2).available_count | object | Optional | Represents the number of feature instances available for use in the organization. Additional keys: not allowed |
$ (anyOf 1).__features[].details (anyOf 2).available_count.total | JSON | Required within parent | |
$ (anyOf 1).__features[].details (anyOf 2).available_count.total (anyOf 1) | integer | Alternative | Represents the total number of available instances for the feature. Always returned in the response. Format: int32 |
$ (anyOf 1).__features[].details (anyOf 2).available_count.total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).__features[].details (anyOf 2).limits | Model | Optional | Expand Features — response body — features, info features item details available count, limits, used count limits |
$ (anyOf 1).__features[].details (anyOf 2).used_count | JSON | Optional | Represents the used count of the feature |
$ (anyOf 1).__features[].details (anyOf 2).used_count (anyOf 1) | object | Alternative | Represents the used count of the feature Additional keys: allowed |
$ (anyOf 1).__features[].details (anyOf 2).used_count (anyOf 1).total | JSON | Required within parent | |
$ (anyOf 1).__features[].details (anyOf 2).used_count (anyOf 1).total (anyOf 1) | integer | Alternative | Represents the total count Format: int32 |
$ (anyOf 1).__features[].details (anyOf 2).used_count (anyOf 1).total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).__features[].details (anyOf 2).used_count (anyOf 2) | JSON | Alternative | |
$ (anyOf 1).__features[].details (anyOf 2).used_count (anyOf 2) (anyOf 1) | integer | Alternative | Represents the used count of the feature Format: int32 |
$ (anyOf 1).__features[].details (anyOf 2).used_count (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).__features[].feature_label | JSON | Required within parent | |
$ (anyOf 1).__features[].feature_label (anyOf 1) | string | Alternative | Represents the display label of the feature for presentation in the CRM interface. Always returned in the response. Maximum length: 255 |
$ (anyOf 1).__features[].feature_label (anyOf 2) | null | Alternative | Represents the display label of the feature for presentation in the CRM interface. Always returned in the response. Maximum length: 255 |
$ (anyOf 1).__features[].module_supported | boolean | Required within parent | Indicates whether the feature is supported for the CRM module specified in the request. Possible values: true - The feature is supported for the specified module. false - The feature is not supported for the specified module. Always returned in the response. |
$ (anyOf 1).__features[].parent_feature | JSON | Required within parent | |
$ (anyOf 1).__features[].parent_feature (anyOf 1) | object | Alternative | Represents the parent feature of the current feature, when applicable. Always returned in the response. |
$ (anyOf 1).__features[].parent_feature (anyOf 1).api_name | string | Required within parent | Represents the API name of the parent feature. Always returned in the response. Maximum length: 255 |
$ (anyOf 1).__features[].parent_feature (anyOf 2) | null | Alternative | Represents the parent feature of the current feature, when applicable. Always returned in the response. |
$ (anyOf 1).__features[].parent_feature (anyOf 2).api_name | string | Required within parent | Represents the API name of the parent feature. Always returned in the response. Maximum length: 255 |
$ (anyOf 1).info | object | Optional | Represents the pagination metadata for the response, including the current page number, page size, total feature count, and whether more records are available. Additional keys: allowed |
$ (anyOf 1).info.count | JSON | Required within parent | |
$ (anyOf 1).info.count (anyOf 1) | integer | Alternative | Represents the number of feature records returned in the current page. Always returned in the response. Format: int32 |
$ (anyOf 1).info.count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).info.more_records | boolean | Required within parent | Indicates whether additional feature records are available beyond the current page. Possible values: true - More feature records are available on subsequent pages. false - The current page contains the last set of feature records. Always returned in the response. |
$ (anyOf 1).info.page | JSON | Required within parent | |
$ (anyOf 1).info.page (anyOf 1) | integer | Alternative | Represents the current page number in the paginated response. Always returned in the response. Format: int32 |
$ (anyOf 1).info.page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).info.per_page | JSON | Required within parent | |
$ (anyOf 1).info.per_page (anyOf 1) | integer | Alternative | Represents the number of feature records included per page in the response. Always returned in the response. Format: int32 |
$ (anyOf 1).info.per_page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 2) | null | Alternative |
Referenced models: Features — response body — features, info features item components null item, Features — response body — features, info features item details available count, limits, used count limits
Schemas
Section titled “Schemas”Features — response body — features, info features item components null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a single component of the feature, including its API name, per-module support status, and usage limit details. Additional keys: allowed |
api_name | string | Required within parent | Represents the API name of the component within the feature. Always returned in the response. Maximum length: 255 |
details | JSON | Required within parent | |
details (anyOf 1) | Model | Alternative | Expand Features — response body — features, info features item components null item details limits, used count — shared_details_51863a186607 |
details (anyOf 2) | Model | Alternative | Expand Features — response body — features, info features item components null item details limits, used count — shared_details_2046e28fca5b |
feature_label | string | Required within parent | Represents the display label of the component for presentation in the CRM interface. Always returned in the response. Maximum length: 255 |
module_supported | boolean | Required within parent | Indicates whether the component is supported for the specified module. Possible values: true - The component is supported for the module. false - The component is not supported for the module. Always returned in the response. |
Referenced models: Features — response body — features, info features item components null item details limits, used count — shared_details_2046e28fca5b, Features — response body — features, info features item components null item details limits, used count — shared_details_51863a186607
Features — response body — features, info features item details available count, limits, used count limits
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the maximum usage limits for the feature, including the absolute total limit and the edition-level ceiling. Additional keys: not allowed |
edition_limit | JSON | Optional | |
edition_limit (anyOf 1) | integer | Alternative | Represents the maximum count for the feature allowed by the current subscription edition. Format: int32 |
edition_limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total | JSON | Required within parent | |
total (anyOf 1) | integer | Alternative | Represents the absolute maximum count for the feature across all editions. Always returned in the response. Format: int32 |
total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Features — response body — features, info features item components null item details limits, used count — shared_details_2046e28fca5b
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | null | Root | Represents the usage limits and consumption details for the component. Always returned in the response. |
limits | Model | Optional | Expand Specific Feature — response body — features features item components null item details limits, used count limits |
used_count | JSON | Optional | Represents theused count of the feature |
used_count (anyOf 1) | object | Alternative | Represents the used count of the feature Additional keys: allowed |
used_count (anyOf 1).total | JSON | Required within parent | |
used_count (anyOf 1).total (anyOf 1) | integer | Alternative | Represents the total count Format: int32 |
used_count (anyOf 1).total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
used_count (anyOf 2) | JSON | Alternative | |
used_count (anyOf 2) (anyOf 1) | integer | Alternative | Represents the used count of the feature Format: int32 |
used_count (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Specific Feature — response body — features features item components null item details limits, used count limits
Features — response body — features, info features item components null item details limits, used count — shared_details_51863a186607
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the usage limits and consumption details for the component. Always returned in the response. |
limits | Model | Optional | Expand Specific Feature — response body — features features item components null item details limits, used count limits |
used_count | JSON | Optional | Represents theused count of the feature |
used_count (anyOf 1) | object | Alternative | Represents the used count of the feature Additional keys: allowed |
used_count (anyOf 1).total | JSON | Required within parent | |
used_count (anyOf 1).total (anyOf 1) | integer | Alternative | Represents the total count Format: int32 |
used_count (anyOf 1).total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
used_count (anyOf 2) | JSON | Alternative | |
used_count (anyOf 2) (anyOf 1) | integer | Alternative | Represents the used count of the feature Format: int32 |
used_count (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Specific Feature — response body — features features item components null item details limits, used count limits
Specific Feature — response body — features features item components null item details limits, used count limits
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the usage limits configured for the component. Always returned in the response. Additional keys: allowed |
edition_limit | JSON | Optional | |
edition_limit (anyOf 1) | integer | Alternative | Represents the maximum count for the component allowed by the current subscription edition. Format: int32 |
edition_limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total | JSON | Required within parent | |
total (anyOf 1) | integer | Alternative | Represents the absolute maximum count for the component, independent of the subscription edition. Always returned in the response. Format: int32 |
total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: zoho.getfeaturedetails. Catalog operation: getFeatureDetails. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
No-content response statuses: [204]