Zoho: Get Custom View By Id

Zoho customViews.getCustomViewById: arguments, response, policy and SDK examples.

Operation zoho.getcustomviewbyid

Provider route: GET /crm/v8/settings/custom_views/{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["customViews"]["getCustomViewById"]>[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.customViews.getCustomViewById(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.custom_views.get_custom_view_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	Format: int64 Maximum length: 25
`query`	object	Required within parent	Additional keys: not allowed
`query.module`	string	Required within parent	Maximum length: 25
`query.include_inner_details`	string	Optional	Maximum length: 50

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)`	Model	Alternative	Expand Get Custom View By Id — response body — custom views, info
`$ (anyOf 2)`	null	Alternative

Referenced models: Get Custom View By Id — response body — custom views, info

Schemas

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

Get Custom View By Id — response body — custom views, info

Field	Type	Presence	Description and constraints
`$`	object	Root	Get a specific custom view of a module using custom view ID Additional keys: not allowed
`custom_views`	array	Required within parent	List of custom views Maximum items: 1
`custom_views[]`	JSON	Each item	Custom view detail item
`custom_views[] (allOf 1)`	Model	All variants apply	Expand Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me
`custom_views[] (allOf 2)`	JSON	All variants apply	Custom view item with required fields
`info`	JSON	Required within parent	Additional information about the response
`info (allOf 1)`	Model	All variants apply	Expand Get All Custom Views — response body — info count, default, more records, page, per page, translation
`info (allOf 2)`	JSON	All variants apply	Custom view info with required fields

Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents the details of a Custom View returned in the response, including its filter criteria, sort configuration, field list, and access control settings. Additional keys: not allowed
`$modified_criteria`	boolean	Optional	Indicates whether the filter criteria of the Custom View has been modified since it was originally created. Possible values: true - The criteria has been modified. false - The criteria has not been modified.
`access_type`	string	Optional	Represents the access type of the Custom View. Possible values: shared - The view is shared with selected users, roles, groups, or territories. public - The view is accessible to all users in the organization. only_to_me - The view is private and accessible only to the creator. Known values: shared, public, only_to_me
`category`	string	Optional	Represents the category of the Custom View. Possible values: public_views - Views accessible to all users in the organization. other_users_views - Views created by other users in the organization. shared_with_me - Views shared with the current user. created_by_me - Views created by the current user. Known values: public_views, other_users_views, shared_with_me, created_by_me
`created_by`	JSON	Optional
`created_by (anyOf 1)`	Model	Alternative	Expand Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me created by id, name
`created_by (anyOf 2)`	null	Alternative	No user associated
`created_time`	JSON	Optional
`created_time (anyOf 1)`	string	Alternative	Represents the date and time when the Custom View creation occurred. Format: date-time
`created_time (anyOf 2)`	null	Alternative	Represents the date and time when the Custom View creation occurred. Format: date-time
`criteria`	Model	Optional	Expand Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me criteria
`cross_filters`	Model	Optional	Expand Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me cross filters
`default`	boolean	Optional	Indicates whether the Custom View is set as the default view for the module. Possible values: true - This is the default view. false - This is not the default view.
`display_value`	string	Optional	Represents the display label of the Custom View as shown to users. Maximum length: 50
`favorite`	JSON	Optional
`favorite (anyOf 1)`	null	Alternative	Represents the favorite order of the Custom View. A null value indicates the view is not marked as a favorite. Format: int32
`favorite (anyOf 2)`	JSON	Alternative
`favorite (anyOf 2) (anyOf 1)`	integer	Alternative	Represents the favorite order of the Custom View. A null value indicates the view is not marked as a favorite. Format: int32
`favorite (anyOf 2) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`fields`	Model	Optional	Expand Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me fields
`id`	string	Optional	Represents the unique ID of the Custom View. Format: int64 Maximum length: 25
`last_accessed_time`	JSON	Optional
`last_accessed_time (anyOf 1)`	string	Alternative	Represents the date and time when the Custom View was last accessed. A null value indicates the view has not been accessed. Format: date-time
`last_accessed_time (anyOf 2)`	null	Alternative	Represents the date and time when the Custom View was last accessed. A null value indicates the view has not been accessed. Format: date-time
`locked`	boolean	Optional	Indicates whether the Custom View is locked and cannot be modified by users. Possible values: true - The view is locked. false - The view is not locked.
`modified_by`	JSON	Optional
`modified_by (anyOf 1)`	Model	Alternative	Expand Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me created by id, name
`modified_by (anyOf 2)`	null	Alternative	No user associated
`modified_time`	JSON	Optional
`modified_time (anyOf 1)`	string	Alternative	Modification Time of the Custom View Format: date-time
`modified_time (anyOf 2)`	null	Alternative	Modification Time of the Custom View Format: date-time
`name`	string	Optional	Represents the name of the Custom View. Maximum length: 50
`offline`	boolean	Optional	Indicates whether the Custom View is available in offline mode. Possible values: true - The view is available offline. false - The view is not available offline.
`shared_to`	Model	Optional	Expand Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me shared to
`sort_by`	JSON	Optional	Represents the field used to sort the records in the Custom View.
`sort_by (anyOf 1)`	Model	Alternative	Expand Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me sort by api name, id
`sort_by (anyOf 2)`	null	Alternative	No sort is applied
`sort_order`	JSON	Optional	Represents the sort order applied to the records in the Custom View.
`sort_order (anyOf 1)`	string	Alternative	Represents the sort order applied to the Custom View. Possible values: asc - Ascending order. desc - Descending order. Known values: asc, desc
`sort_order (anyOf 2)`	null	Alternative	Represents no sort order applied to the Custom View.
`system_defined`	boolean	Optional	Indicates whether the Custom View is a system-defined view created by Zoho CRM. Possible values: true - The view is system-defined. false - The view is user-defined.
`system_name`	JSON	Optional
`system_name (anyOf 1)`	string	Alternative	Represents the system-defined name of the Custom View. A null value indicates the view does not have a system name. Maximum length: 50
`system_name (anyOf 2)`	null	Alternative	Represents the system-defined name of the Custom View. A null value indicates the view does not have a system name. Maximum length: 50

Referenced models: Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me created by id, name, Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me criteria, Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me cross filters, Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me fields, Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me sort by api name, id, Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me shared to

Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me created by id, name

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents a user reference containing the user ID and display name. Additional keys: not allowed
`id`	string	Required within parent	Represents the unique ID of the user. Format: int64 Maximum length: 25
`name`	string	Required within parent	Represents the display name of the user. Maximum length: 255

Policy, approvals and errors

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

Report an issue with this page