Zoho: Get Zia Org Enrichment

← Zia org enrichment operations · Get started

Operation zoho.getziaorgenrichment

Provider route: GET /crm/v8/__zia_org_enrichment. 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"]["getZiaOrgEnrichment"]>[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.getZiaOrgEnrichment(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_zia_org_enrichment(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.page	integer	Optional	One of: 1, 2 Format: int32
query.per_page	integer	Optional	One of: 100 Format: int32
query.sort_by	string	Optional	One of: created_time
query.sort_order	string	Optional	One of: asc, desc
query.status	string	Optional	One of: COMPLETED, FAILED, DATA_NOT_FOUND, SCHEDULED

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 list of organization enrichment jobs is retrieved successfully. Additional keys: not allowed
$ (anyOf 1).__zia_org_enrichment	array	Required within parent	Contains the list of organization enrichment jobs for the current page. Maximum items: 200
$ (anyOf 1).__zia_org_enrichment[]	object	Each item	Represents a single organization enrichment job and its scheduling metadata. Additional keys: not allowed
$ (anyOf 1).__zia_org_enrichment[].created_by	object	Required within parent	Identifies the CRM user who triggered the enrichment job. Additional keys: not allowed
$ (anyOf 1).__zia_org_enrichment[].created_by.id	string	Required within parent	Shows the unique identifier of the CRM user who triggered the enrichment job. Maximum length: 19
$ (anyOf 1).__zia_org_enrichment[].created_by.name	string	Required within parent	Shows the display name of the CRM user who triggered the enrichment job. Maximum length: 255
$ (anyOf 1).__zia_org_enrichment[].created_time	string	Required within parent	Shows the timestamp at which the enrichment job was scheduled, in ISO 8601 format. Format: date-time
$ (anyOf 1).__zia_org_enrichment[].id	string	Required within parent	Shows the unique identifier of the organization enrichment job. Use this identifier with GET `/__zia_org_enrichment/{id}` to retrieve the enriched data of the 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: SCHEDULED - The job is queued and yet to run. COMPLETED - The job has finished and enriched data is available. FAILED - The job ended in a failure. DATA_NOT_FOUND - The job completed but Zia could not locate public data to enrich. Known values: SCHEDULED, COMPLETED, DATA_NOT_FOUND, FAILED, RUNNING
$ (anyOf 1).info	object	Required within parent	Contains pagination metadata for the current page of enrichment jobs. Additional keys: not allowed
$ (anyOf 1).info.count	JSON	Required within parent
$ (anyOf 1).info.count (anyOf 1)	integer	Alternative	Shows the number of enrichment jobs returned in the current page. Format: int32 Maximum: 200
$ (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 enrichment jobs exist beyond the current page. When the value is `true`, fetch the next page using the `page` parameter.
$ (anyOf 1).info.page	JSON	Required within parent
$ (anyOf 1).info.page (anyOf 1)	integer	Alternative	Shows the page number that this response corresponds to. 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	Shows the configured number of enrichment jobs per page. Format: int32 Maximum: 200
$ (anyOf 1).info.per_page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 2)	null	Alternative

Policy, approvals and errors

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