Zoho: Tags — tags get Tags

← Tags operations · Get started

Operation zoho.gettags

Provider route: GET /crm/v8/settings/tags. 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["tags"]["getTags"]>[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.tags.getTags(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.get_tags(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Required within parent	Additional keys: not allowed
query.module	string	Required within parent	Maximum length: 100
query.include	string	Optional	One of: type, associated_record_count, last_accessed_time

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 Tags — tags get Tags — response body

Referenced models: Tags — tags get Tags — response body

Schemas

Tags — tags get Tags — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response body for a successful tag list retrieval. Additional keys: not allowed
info	Model	Required within parent	Expand Tags — tags get Tags — response body — info
tags	array	Required within parent	Represents an array of tag objects returned for the module. Maximum items: 484
tags[]	Model	Each item	Expand Tags — tags get Tags — response body — tags item

Referenced models: Tags — tags get Tags — response body — info, Tags — tags get Tags — response body — tags item

Tags — tags get Tags — response body — info

Field	Type	Presence	Description and constraints
$	object	Root	Represents pagination and limit information for the tag list response. Additional keys: not allowed
allowed_count	JSON	Required within parent
allowed_count (anyOf 1)	integer	Alternative	Represents the maximum number of tags allowed for the module in your plan. Format: int32
allowed_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
count	JSON	Required within parent
count (anyOf 1)	integer	Alternative	Represents the total number of tags returned in the response. Format: int32
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
record_limit	JSON	Optional
record_limit (anyOf 1)	integer	Alternative	Represents the maximum number of records a tag can be applied to. Format: int32
record_limit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Tags — tags get Tags — response body — tags item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a tag object returned in the GET response, including its ID, name, color code, timestamps, and audit user details. Additional keys: not allowed
color_code	JSON	Required within parent
color_code (anyOf 1)	string	Alternative	Represents the hex color code assigned to the tag, such as **#FF0000**. The value is null when no color is assigned. Maximum length: 255
color_code (anyOf 2)	null	Alternative	Represents the hex color code assigned to the tag, such as **#FF0000**. The value is null when no color is assigned. Maximum length: 255
created_by	Model	Required within parent	Expand Tags — tags get Tags — response body — tags item created by
created_time	string	Required within parent	Represents the creation date and time of the tag. Format: date-time Maximum length: 255
id	string	Required within parent	Represents the unique ID of the tag. Maximum length: 255
modified_by	Model	Required within parent	Expand Tags — tags get Tags — response body — tags item modified by
modified_time	string	Required within parent	Represents the last modification date and time of the tag. Format: date-time Maximum length: 255
name	string	Required within parent	Represents the name of the tag. Maximum length: 255

Referenced models: Tags — tags get Tags — response body — tags item created by, Tags — tags get Tags — response body — tags item modified by

Tags — tags get Tags — response body — tags item created by

Field	Type	Presence	Description and constraints
$	object	Root	Represents the user who created the tag in the GET response. Additional keys: not allowed
id	string	Required within parent	Represents the unique ID of the user who created the tag. Maximum length: 255
name	string	Required within parent	Represents the display name of the user who created the tag. Maximum length: 255

Tags — tags get Tags — response body — tags item modified by

Field	Type	Presence	Description and constraints
$	object	Root	Represents the user who last modified the tag in the GET response. Additional keys: not allowed
id	string	Required within parent	Represents the unique ID of the user who last modified the tag. Maximum length: 255
name	string	Required within parent	Represents the display name of the user who last modified the tag. Maximum length: 255

Policy, approvals and errors

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