UI Config

UI Config describes views and folders in the Contentful web app. A view is a list of filters and sorting behavior that refines the content list according to different criteria.

You can set UI Config for all members in an environment, or just for the current user.

UI Config object consists of the following top-level properties:

Field	Type	Description
sys	Sys	Common system properties. For detailed description of properties, please refer to Common resource attributes.
assetListViews	Array[Object]	Views for assets
entryListViews	Array[Object]	Views for entries
homeViews[].widgetId	String	App ID to render on the Home page
homeViews[].widgetNamespace	’app’ \| ‘builtin’	App or built-in widget
livePreview.previewMode	’livePreview’ \| ‘legacyPreview’	Preview mode
publish.publishMode	’localePublishing’ \| ‘entryPublishing’	Publish mode: entry-based publishing or locale-based publishing
timeline.mode	’disabled’ \| ‘timeline’	Timeline enabled/disabled
timeline.timelineConfig.entityScheduling	’enabled’ \| ‘disabled’	Setting controlling whether regular entity scheduling is enabled when Timeline is turned on.

Timeline feature is only available on the Premium/Enterprise pricing plans.

Views accept multiple content types using the property contentTypeIds. However, contentTypeId is still supported. When both properties are present, they need to be aligned and refer to the same content type ID.

Get the UI Config

This endpoint returns the available UI Config in the current environment.

Update the UI Config

You can use this endpoint to update the UI Config in your environment. These settings are visible to everyone in the environment.

User UI Config

To update the UI Config of the current user only, you can set the User UI Config. Changing the User UI Config won’t affect other members in the environment.

Get the User UI Config

Update the User UI Config

You can use this endpoint to update your User UI Config.