Zoho: List available REST AP Is

← Apis operations · Get started

Operation zoho.getavailableapis

Provider route: GET /crm/v8/__apis. Alter supplies the connection’s credentials and routing.

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["apis"]["getAvailableApis"]>[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.apis.getAvailableApis(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from 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.apis.get_available_apis(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.filters	string	Optional	Maximum length: 2048

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
$	object	Root	Contains the list of available REST APIs and their operation types. Additional keys: not allowed
__apis	array	Required within parent	Contains the details of all the supported APIs in the API version given in the request URL. Maximum items: 2000
__apis[]	object	Each item	Each object represents an API with its path and supported HTTP operations. Additional keys: not allowed
__apis[].operation_types	array	Required within parent	Contains the supported HTTP operations for that API in that version. Maximum items: 10
__apis[].operation_types[]	object	Each item	Each object represents the details of a single HTTP operation supported by that API. Additional keys: not allowed
__apis[].operation_types[].max_credits	JSON	Required within parent
__apis[].operation_types[].max_credits (anyOf 1)	integer	Alternative	Represents the maximum credits that the API consumes. Format: int32 Minimum: 0
__apis[].operation_types[].max_credits (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
__apis[].operation_types[].method	string	Required within parent	Represents the supported request method for that API. Possible values: GET - Retrieve data. POST - Create data. PUT - Update data. PATCH - Partially update data. DELETE - Remove data. Known values: GET, POST, PUT, PATCH, DELETE
__apis[].operation_types[].min_credits	JSON	Required within parent
__apis[].operation_types[].min_credits (anyOf 1)	integer	Alternative	Represents the minimum credits that the API consumes. Format: int32 Minimum: 0
__apis[].operation_types[].min_credits (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
__apis[].operation_types[].oauth_scope	string	Required within parent	Represents the OAuth scope required to perform this operation. Maximum length: 128
__apis[].path	string	Required within parent	Represents the API endpoint for the API version in the request URL. Maximum length: 512

Policy, approvals and errors

SDK function policy ID: zoho.getavailableapis. Catalog operation: getAvailableApis. 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.

Official provider source