API Docs

Get View Settings

Get View Settings - kintone.app.getView()

Retrieves the current view settings information of an App.

Function

kintone.app.getView()

Parameters

None

Returns

A Promise object.
The following values can be retrieved when the Promise object is fulfilled:

Property Type Description
type String The type of View.
  • LIST: List View
  • CALENDAR: Calendar View
  • CUSTOM: Custom View
builtinType String The type of the built-in View.
  • ASSIGNEE: Assigned to me View.
  • ALL: All records View.
Not returned for other Views.
name String The name of the View.
id String The ID of the View.
fields Array The list of field codes for the fields displayed in the View.
Returned for LIST Views.
date String The field code set for the Date Field.
Returned for CALENDAR Views.
title String The field code set for the Title Field.
Returned for CALENDAR Views.
html String The HTML content set for the Custom View.
Returned for CUSTOM Views.
pager Boolean The pagination settings.
Returned for CUSTOM Views.
  • true: Enabled
  • false: Disabled
device String The scope of where the view is displayed.
Returned for CUSTOM Views.
  • DESKTOP: Display only on desktop
  • ANY: Display on both desktop and mobile
filterCond String The Filter setting as a query.
For more information on query formats, refer to the following article:
Query string
sort String The Sort by order as a query.
For more information on query formats, refer to the following article:
Query string

Available Pages

  • Record List

Notes

This API retrieves the configured values of the View from the App settings. Even if the view's filter is updated through the UI on the List View, the returned values will not change.
To retrieve the current Filter setting or sort order, use the following APIs: