Zoho: Get Tag Records Count

← Tags actions operations · Get started

Operation zoho.gettagrecordscount

Provider route: GET /crm/v8/settings/tags/{id}/actions/records_count. 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["tagsActions"]["getTagRecordsCount"]>[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.tagsActions.getTagRecordsCount(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.tags_actions.get_tag_records_count(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.id	string	Required within parent	Maximum length: 19
query	object	Required within parent	Additional keys: not allowed
query.id	string	Optional	Maximum length: 19
query.module	string	Required within parent	Maximum length: 100

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
$	Model	Root	Expand Get Tag Records Count — response body

Referenced models: Get Tag Records Count — response body

Schemas

9 more schemas are linked from the tables above, on the schema pages.

Get Tag Records Count — response body

Field	Type	Presence	Description and constraints
$	object	Root	Success response for tag records count API. Additional keys: not allowed
configured_areas	Model	Optional	Expand Get Tag Records Count — response body — configured areas
count	string	Required within parent	Total count of records associated with the tag Maximum length: 255

Referenced models: Get Tag Records Count — response body — configured areas

Get Tag Records Count — response body — configured areas

Field	Type	Presence	Description and constraints
$	object	Root	Nested schema for configured_areas in records count response. Additional keys: not allowed
custom_view	Model	Required within parent	Expand Get Tag Records Count — response body — configured areas custom view
workflow_tagActionRecords	Model	Required within parent	Expand Get Tag Records Count — response body — configured areas workflow tag Action Records

Referenced models: Get Tag Records Count — response body — configured areas custom view, Get Tag Records Count — response body — configured areas workflow tag Action Records

Get Tag Records Count — response body — configured areas custom view

Field	Type	Presence	Description and constraints
$	object	Root	Nested schema for custom_view configurations. Additional keys: not allowed
cvids	array	Required within parent	List of custom view IDs Maximum items: 0
cvids[]	JSON	Each item
cvmodules	array	Required within parent	List of modules with custom views Maximum items: 0
cvmodules[]	JSON	Each item
cvnames	array	Required within parent	List of custom view names Maximum items: 0
cvnames[]	JSON	Each item
inaccessible_custom_view_present	boolean	Required within parent	Indicates whether inaccessible custom views exist

Get Tag Records Count — response body — configured areas workflow tag Action Records

Field	Type	Presence	Description and constraints
$	object	Root	Nested schema for workflow tag action records. Additional keys: not allowed
Blueprint	Model	Required within parent	Expand Get Tag Records Count — response body — configured areas workflow tag Action Records Blueprint — GETBlueprint Nested
Orchestration	Model	Required within parent	Expand Get Tag Records Count — response body — configured areas workflow tag Action Records Orchestration — GETOrchestration Nested
Workflow	Model	Required within parent	Expand Get Tag Records Count — response body — configured areas workflow tag Action Records Workflow — GETWorkflow Nested

Referenced models: Get Tag Records Count — response body — configured areas workflow tag Action Records Blueprint — GETBlueprint Nested, Get Tag Records Count — response body — configured areas workflow tag Action Records Orchestration — GETOrchestration Nested, Get Tag Records Count — response body — configured areas workflow tag Action Records Workflow — GETWorkflow Nested

Get Tag Records Count — response body — configured areas workflow tag Action Records Blueprint — GETBlueprint Nested

Field	Type	Presence	Description and constraints
$	object	Root	Nested schema for Blueprint configurations. Additional keys: not allowed
3060320000000666022	Model	Required within parent	Expand Get Tag Records Count — response body — configured areas workflow tag Action Records Blueprint — GET3060320000000666022 Nested1

Referenced models: Get Tag Records Count — response body — configured areas workflow tag Action Records Blueprint — GET3060320000000666022 Nested1

Get Tag Records Count — response body — configured areas workflow tag Action Records Orchestration — GETOrchestration Nested

Field	Type	Presence	Description and constraints
$	object	Root	Nested schema for Orchestration configurations. Additional keys: not allowed
3060320000000666022	Model	Required within parent	Expand Get Tag Records Count — response body — configured areas workflow tag Action Records Orchestration — GET3060320000000666022 Nested

Referenced models: Get Tag Records Count — response body — configured areas workflow tag Action Records Orchestration — GET3060320000000666022 Nested

Get Tag Records Count — response body — configured areas workflow tag Action Records Workflow — GETWorkflow Nested

Field	Type	Presence	Description and constraints
$	object	Root	Nested schema for Workflow configurations. Additional keys: not allowed
3060320000000666022	Model	Required within parent	Expand Get Tag Records Count — response body — configured areas workflow tag Action Records Workflow — GET3060320000000666022 Nested2

Referenced models: Get Tag Records Count — response body — configured areas workflow tag Action Records Workflow — GET3060320000000666022 Nested2

Get Tag Records Count — response body — configured areas workflow tag Action Records Blueprint — GET3060320000000666022 Nested1

Field	Type	Presence	Description and constraints
$	object	Root	Nested schema for tag ID 3060320000000666022 configurations. Additional keys: not allowed
AddTags	array	Required within parent	AddTags configurations Maximum items: 1
AddTags[]	Model	Each item	Expand Get Tag Records Count — response body — configured areas workflow tag Action Records Blueprint Add Tags item
RemoveTags	array	Required within parent	RemoveTags configurations Maximum items: 1
RemoveTags[]	Model	Each item	Expand Get Tag Records Count — response body — configured areas workflow tag Action Records Blueprint Remove Tags item

Referenced models: Get Tag Records Count — response body — configured areas workflow tag Action Records Blueprint Add Tags item, Get Tag Records Count — response body — configured areas workflow tag Action Records Blueprint Remove Tags item

Get Tag Records Count — response body — configured areas workflow tag Action Records Orchestration — GET3060320000000666022 Nested

Field	Type	Presence	Description and constraints
$	object	Root	Nested schema for tag ID 3060320000000666022 configurations. Additional keys: not allowed
AddTags	array	Required within parent	AddTags configurations Maximum items: 1
AddTags[]	Model	Each item	Expand Get Tag Records Count — response body — configured areas workflow tag Action Records Orchestration Add Tags item
RemoveTags	array	Required within parent	RemoveTags configurations Maximum items: 1
RemoveTags[]	Model	Each item	Expand Get Tag Records Count — response body — configured areas workflow tag Action Records Orchestration Remove Tags item

Referenced models: Get Tag Records Count — response body — configured areas workflow tag Action Records Orchestration Add Tags item, Get Tag Records Count — response body — configured areas workflow tag Action Records Orchestration Remove Tags item

Get Tag Records Count — response body — configured areas workflow tag Action Records Workflow — GET3060320000000666022 Nested2

Field	Type	Presence	Description and constraints
$	object	Root	Nested schema for tag ID 3060320000000666022 configurations. Additional keys: not allowed
AddTags	array	Required within parent	AddTags configurations Maximum items: 3
AddTags[]	Model	Each item	Expand Get Tag Records Count — response body — configured areas workflow tag Action Records Workflow Add Tags item
RemoveTags	array	Required within parent	RemoveTags configurations Maximum items: 2
RemoveTags[]	Model	Each item	Expand Get Tag Records Count — response body — configured areas workflow tag Action Records Workflow Remove Tags item

Referenced models: Get Tag Records Count — response body — configured areas workflow tag Action Records Workflow Add Tags item, Get Tag Records Count — response body — configured areas workflow tag Action Records Workflow Remove Tags item

Policy, approvals and errors

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