Get Organization Enrichment Details
Purpose
To get the details of the enriched data of your org.
Endpoints
- GET /__zia_org_enrichment
- GET /__zia_org_enrichment/{job_ID}
Request Details
Request URL
{api-domain}/crm/{version}/__zia_org_enrichment
To get a specific enrichment:
{api-domain}/crm/{version}/__zia_org_enrichment/{{job_id}}
job_id is the ID received while you created org enrichment.
Header
Authorization: Zoho-oauthtoken <access-token>
Scope
ZohoCRM.settings.intelligence.ALL/READ
(or)
ZohoCRM.settings.intelligence.READ
Parameters
- pageoptional
To get the list of records from the respective pages. The default value is 1. Accepts positive integer values only.
- per_pageoptional
To get the list of records available per page. The default and the maximum possible value is 100. Accepts positive integer values only.
- sort_byoptional
To sort the response based on created time. The accepted value is created_time.
- sort_orderoptional
To sort the response either in ascending or descending order. The possible values are asc or desc.
- statusoptional
To get the response based on the status of the scheduled job using the create org enrichment API. The possible values are COMPLETED, SCHEDULED, FAILED, and DATA_NOT_FOUND.
Sample Request
Copied
Response while fetching all org enrichments
When you fetch all org enrichments created, you will get the "id" of the job, "status", "created_time", and "created_by".
Sample Response while fetching all enrichments
Copied
Show full
Show less
Response while fetching a specific org enrichment
When you fetch a specific org enrichment through it's ID, you will get the details of the fields that were enriched.
Possible Errors
- NO_CONTENTHTTP 204
There is no data enrichment created for your org.
Resolution: Create data enrichment for your org. - INVALID_DATAHTTP 400
- You have given an invalid value for the "sort_by" parameter.
Resolution:You can only sort by the created time. - The value for the "status" parameter is incorrect.
Resolution: The possible values are COMPLETED, SCHEDULED, FAILED, and DATA_NOT_FOUND. - The value for the "sort_order" parameter is invalid.
Resolution: The possible values for this parameter are asc and desc.
- You have given an invalid value for the "sort_by" parameter.
- FEATURE_NOT_ENABLEDHTTP 400
Data enrichment feature is not enabled for your account.
Resolution: Enable data enrichment feature or contact your system administrator. - FEATURE_NOT_SUPPORTEDHTTP 400
Data enrichment is not available for your edition of CRM.
Resolution: Data enrichment is available only for the Enterprise and Ultimate editions of CRM. Upgrade your edition or contact support@zohocrm.com. - OAUTH_SCOPE_MISMATCHHTTP 401
You do not have the right scope to access this API.
Resolution: Create a new token with the scopes mentioned in the "Scopes" section and try this API. - NO_PERMISSIONHTTP 403
You do not have the Manage or View Data Enrichment permission to access this feature.
Resolution: Contact your system administrator. - INTERNAL_SERVER_ERRORHTTP 500
Unhandled and unexpected exception in server.
Resolution: Contact support@zohocrm.com for assistance.
Sample response for a specific org enrichment
Copied