Get Views

Gets the View settings of an App.
Method GET
URL https://{subdomain}
URL(guest space) https://{subdomain}{SpaceID}/v1/app/views.json
Authentication API Token Authentication Password Authentication

Pre-live settings

Apps may hold pre-live settings that have not yet been deployed to the live app.
Access the pre-live settings with the below URL.

URL https://{subdomain}
URL(guest space) https://{subdomain}{SpaceID}/v1/preview/app/views.json


  • Permission to view records are needed when obtaining information of live apps.
  • App Management Permissions are needed when obtaining information of pre-live settings.

Request Parameters

Parameter Value Required Description
app Integer Yes The App ID
lang String  

The localized language to retrieve the data in:

  • default: retrieves the default names
  • en: retrieves the localized English names
  • zh: retrieves the localized Chinese names
  • ja: retrieves the localized Japanese names
  • user: retrieves the localized names, in the same language as the language setting* set on the user used for the authentication.

If ignored, the default names will be retrieved.

*If the user language setting is set to "Use Web browser settings", the settings set in the Accept-Language header will be used. If there is no Accept-Language header, the language set in the "Localization" settings in the System Administrator's menu will be used.

Sample Request

JavaScript (using Kintone REST API Request)


Response Parameters

Parameter Type Description
revision String The revision number of the App settings.
views Object An object listing View information.
views.{viewname}.builtinType String The type of the built-in View.
  • ASSIGNEE: The "Assigned to me" View.
    (This list is automatically created if the Process Management settings have been enabled in the app.)
  • Currently, there are no other types of built-in Views.
views.{viewname}.date String The field code set for the Date Field.
Responded for Calendar Views.
views.{viewname}.fields Array The list of field codes for the fields displayed in the View.
Responded for List Views.
views.{viewname}.filterCond String The filter condition as a query.
Check here for more information on query formats.
views.{viewname}.html String The HTML code set for the View.
Responded for Custom Views.
views.{viewname}.id String The View ID.
views.{viewname}.index String The display order (ascending) of the View, when listed with other views.
views.{viewname}.name String The name of the View.
views.{viewname}.pager Boolean The pagination settings.
Responded for Custom Views.
  • true: Enabled
  • false: Disabled
views.{viewname}.device String

The scope of where the view is displayed.

  • DESKTOP: Display only on desktop
  • ANY: Display on both desktop and mobile
views.{viewname}.sort String The sort order as a query.
Check here for more information on query formats.
views.{viewname}.title String The field code set for the Title Field.
Responded for Calendar Views.
views.{viewname}.type String The type of View.
  • LIST: List View
  • CALENDAR: Calendar View
  • CUSTOM: Custom View

Sample Response


This API cannot be used to retrieve View settings if there are multiple Views with the same name.

Was this article helpful?
0 out of 0 found this helpful
Do you have any questions or issues related to this article?
Please share your views with us in the Community forums!