Zoho: Org Enrichment Details

← Zia org enrichment operations · Get started

Operation zoho.getorgenrichmentbyid

Provider route: GET /crm/v8/__zia_org_enrichment/{id}. 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["ziaOrgEnrichment"]["getOrgEnrichmentById"]>[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.ziaOrgEnrichment.getOrgEnrichmentById(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.zia_org_enrichment.get_org_enrichment_by_id(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: 255

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	Defines the response body returned when the requested organization enrichment job is retrieved successfully. Additional keys: not allowed
$ (anyOf 1).__zia_org_enrichment	array	Required within parent	Contains the details of the requested organization enrichment job. Maximum items: 1
$ (anyOf 1).__zia_org_enrichment[]	object	Each item	Represents the full record of a single organization enrichment job, including its trigger fields and enriched output. Additional keys: not allowed
$ (anyOf 1).__zia_org_enrichment[].enrich_based_on	object	Required within parent	Shows the trigger values that were supplied when the enrichment job was scheduled. Additional keys: not allowed
$ (anyOf 1).__zia_org_enrichment[].enrich_based_on.email	string	Optional	Shows the email address that was used as a trigger value. Format: email Maximum length: 255
$ (anyOf 1).__zia_org_enrichment[].enrich_based_on.name	string	Optional	Shows the organization name that was used as a trigger value. Maximum length: 255
$ (anyOf 1).__zia_org_enrichment[].enrich_based_on.website	string	Optional	Shows the website domain that was used as a trigger value. Maximum length: 255
$ (anyOf 1).__zia_org_enrichment[].enriched_data	JSON	Required within parent
$ (anyOf 1).__zia_org_enrichment[].enriched_data (anyOf 1)	object	Alternative	Contains the data retrieved by Zia for the organization. The keys present in this object depend on the fields configured in the enrichment configuration of the organization. Returns `null` when the job has not yet completed or when no public data could be retrieved. Additional keys: allowed
$ (anyOf 1).__zia_org_enrichment[].enriched_data (anyOf 2)	null	Alternative	Contains the data retrieved by Zia for the organization. The keys present in this object depend on the fields configured in the enrichment configuration of the organization. Returns `null` when the job has not yet completed or when no public data could be retrieved. Additional keys: allowed
$ (anyOf 1).__zia_org_enrichment[].id	string	Required within parent	Shows the unique identifier of the organization enrichment job. Maximum length: 19
$ (anyOf 1).__zia_org_enrichment[].status	string	Required within parent	Indicates the current execution status of the enrichment job. Possible values: COMPLETED - The job has finished and enriched data is available. SCHEDULED - The job is queued and yet to run. FAILED - The job ended in a failure. DATA_NOT_FOUND - The job completed but Zia could not locate public data to enrich. Known values: COMPLETED, SCHEDULED, FAILED, DATA_NOT_FOUND, RUNNING
$ (anyOf 2)	null	Alternative

Policy, approvals and errors

SDK function policy ID: zoho.getorgenrichmentbyid. Catalog operation: getOrgEnrichmentById. 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]

Official provider source