Get All Custom Views

GET/settings/custom_views

Use it in a workflow

Add a step and choose the Zoho CRM connector.
Pick the Get All Custom Views action (under Metadata).
Fill in the fields below, then reference the result from later steps as {{getAllCustomViews.response.data}}.

Request

Query parameters

modulestringrequired

Specify the API name of the module for which to manage Custom Views. Refer to the Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve module IDs.resource for valid values.

filtersoneOf

Specify the filter criteria for retrieving specific Custom Views. Accepts a filter object to narrow down results based on Custom View properties.

pageinteger (int32)

Specify the page number for pagination.

per_pageinteger (int32)

Specify the number of Custom Views to return per page.

idsarray<string (int64)>required

Specify the comma-separated list of unique IDs of the Custom Views to delete. Accepts up to 100 IDs. Use the [Get Custom Views API](custom_views.yaml#$.paths./settings/custom_views.get) to retrieve the custom view IDs.

scopestring

Represents the category of custom views to fetch. Allowed values are 'created_by_me', 'shared_with_me', 'public_views', 'other_users_views'.

One ofcreated_by_meshared_with_mepublic_viewsother_users_views

favouriteboolean

Filter custom views by favourite status. Set to true to fetch only favourite custom views.

Response

Returns 200 with an object. Read it in later steps with {{getAllCustomViews.response.data.<field>}}.

custom_viewsarray<any>

List of custom views

infoany

Pagination info for the response

json

{
  "custom_views": [
    null
  ],
  "info": null
}

Need more? See the Zoho CRM guide for connection setup and behaviour shared by every action.

Was this page helpful?