Zoho: Get All Custom Views

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

Operation zoho.getcustomviews

Provider route: GET /crm/v8/settings/custom_views. 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"]["getCustomViews"]>[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.getCustomViews(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_views(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: 25
`query.filters`	Model	Optional	Expand Related Records — request body — query filters
`query.page`	integer	Optional	Format: int32 Minimum: 1
`query.per_page`	integer	Optional	Format: int32 Maximum: 200 Minimum: 1
`query.ids`	array	Required within parent	List of custom view IDs Maximum items: 100 Minimum items: 1 Unique items: true
`query.ids[]`	string	Each item	Custom view ID Format: int64
`query.scope`	string	Optional	One of: created_by_me, shared_with_me, public_views, other_users_views
`query.favourite`	boolean	Optional

Referenced models: Related Records — request body — query filters

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 Get All Custom Views — response body

Referenced models: Get All Custom Views — response body

Schemas

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

Related Records — request body — query filters

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Represents the top-level filter criterion for data selection, supporting both simple field-based filters and complex grouped filters with logical operators.
`$ (anyOf 1)`	Model	Alternative	Expand Related Records — request body — query filters value
`$ (anyOf 2)`	Model	Alternative	Expand Related Records — request body — query / filters / group_operator: AND, OR, and, or

Referenced models: Related Records — request body — query / filters / group_operator: AND, OR, and, or, Related Records — request body — query filters value

Get All Custom Views — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Get all custom views of a module Additional keys: not allowed
`custom_views`	array	Required within parent	List of custom views Maximum items: 200
`custom_views[]`	JSON	Each item	Custom view 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	Pagination info for 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	Required pagination fields

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, Get All Custom Views — response body — info count, default, more records, page, per page, translation

Related Records — request body — query / filters / group_operator: AND, OR, and, or

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents a grouped filter criterion containing multiple filter conditions evaluated with a logical operator. Supports recursive nesting for complex filtering logic. Additional keys: not allowed
`group`	array	Required within parent	Contains an array of filter conditions grouped together and evaluated with the specified logical operator. Maximum items: 25 Minimum items: 2
`group[]`	JSON	Each item
`group[] (anyOf 1)`	Model	Alternative	Expand Related Records — request body — query filters value
`group[] (anyOf 2)`	Model	Alternative	Expand Related Records — request body — query / filters / group_operator: AND, OR, and, or
`group_operator`	string	Required within parent	Represents the logical operator applied between the filter conditions in the group. Possible values: AND - All conditions in the group must be satisfied. OR - At least one condition in the group must be satisfied. and - Equivalent to AND; all conditions in the group must be satisfied. or - Equivalent to OR; at least one condition in the group must be satisfied. One of: AND, OR, and, or

Referenced models: Related Records — request body — query / filters / group_operator: AND, OR, and, or, Related Records — request body — query filters value

Related Records — request body — query filters value

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Represents a simple field-based filter criterion that dispatches to the appropriate comparator-specific schema. The equal and not_equal comparators support scalar or array values; text comparators support scalar or array strings; ordering comparators require a scalar; between and not_between comparators require a two-element array; in and not_in comparators require an array of primitives; and include_all, include_any, exclude_all, and exclude_any comparators require an array of lookup objects and apply only when the field's data_type is multiuserlookup or multiselectlookup.
`$ (anyOf 1)`	Model	Alternative	Expand Related Records — request body — query filters value value
`$ (anyOf 2)`	Model	Alternative	Expand Related Records — request body — query / filters / value / comparator: like, not like, starts with, ends with, contains, not contains, type: merge field, pre defined, value, field
`$ (anyOf 3)`	Model	Alternative	Expand Related Records — request body — query / filters / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field
`$ (anyOf 4)`	Model	Alternative	Expand Related Records — request body — query / filters / value / comparator: between, not between, type: merge field, pre defined, value, field
`$ (anyOf 5)`	Model	Alternative	Expand Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field
`$ (anyOf 6)`	Model	Alternative	Expand Related Records — request body — query / filters / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field

Referenced models: Related Records — request body — query / filters / value / comparator: between, not between, type: merge field, pre defined, value, field, Related Records — request body — query filters value value, Related Records — request body — query / filters / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field, Related Records — request body — query / filters / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field, Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field, Related Records — request body — query / filters / value / comparator: like, not like, starts with, ends with, contains, not contains, type: merge field, pre defined, value, field

Get All Custom Views — response body — info count, default, more records, page, per page, translation

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents pagination metadata and category label translations for the Custom Views response. Additional keys: not allowed
`count`	JSON	Optional
`count (anyOf 1)`	integer	Alternative	Represents the total number of Custom Views available for the specified module. Format: int32
`count (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`default`	string	Optional	Represents the ID of the default Custom View for the module. Format: int64 Maximum length: 255
`more_records`	boolean	Optional	Indicates whether more records are available beyond the current page. Possible values: true - More records are available. false - No more records are available.
`page`	JSON	Optional
`page (anyOf 1)`	integer	Alternative	Represents the current page number of the paginated response. Format: int32
`page (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`per_page`	JSON	Optional
`per_page (anyOf 1)`	integer	Alternative	Represents the number of Custom Views returned per page. Format: int32
`per_page (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`translation`	Model	Optional	Expand Get All Custom Views — response body — info count, default, more records, page, per page, translation translation

Referenced models: Get All Custom Views — response body — info count, default, more records, page, per page, translation translation

Related Records — request body — query filters value value

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Represents an equality filter criterion that dispatches to either the EqualFilterCriterionRequest or NotEqualFilterCriterionRequest schema based on the comparator value.
`$ (anyOf 1)`	Model	Alternative	Expand Related Records — request body — query / filters / value / value / comparator: equal, type: merge field, pre defined, value, field
`$ (anyOf 2)`	Model	Alternative	Expand Related Records — request body — query / filters / value / value / comparator: not equal, type: merge field, pre defined, value, field

Referenced models: Related Records — request body — query / filters / value / value / comparator: equal, type: merge field, pre defined, value, field, Related Records — request body — query / filters / value / value / comparator: not equal, type: merge field, pre defined, value, field

Policy, approvals and errors

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

Report an issue with this page