Site Search - Liferay Learn

Product API - Creating a Product with Multiple SKUs

Product API - Creating a Product with Multiple SKUs You can create products with multiple active SKUs using the product API or from the Products application. To create such a product, you must...

Wiki API Basics

Official Documentation

Wiki API Basics Wiki is deprecated as of Liferay DXP 2024.Q4/Portal GA129. For data continuity, consider transitioning to alternative content management solutions like Liferay Objects or Web...

Document Types and Metadata Sets API Basics

Official Documentation

Document Types and Metadata Sets API Basics Liferay DXP 2025.Q1+/Portal GA132+ Liferay's headless delivery application provides REST services for Documents and Media that add document types and...

Document API Basics

Official Documentation

Document API Basics Liferay's headless delivery application provides REST services for Documents and Media that add documents and folders, list their information, modify them, delete them, and...

Captcha API Basics

Official Documentation

Captcha API Basics Liferay provides a headless API to retrieve and submit captchas using the SimpleCAPTCHA engine. Using the /captcha endpoint from the API Explorer, you can add captchas in your...

Document Shortcut API Basics

Official Documentation

Document Shortcut API Basics Liferay's headless delivery application provides REST services for Documents and Media that add document shortcuts to sites or asset libraries, list their information,...

Liferay Security APIs

Liferay Security APIs You can use headless APIs to interface with important Liferay security features, including CAPTCHA configurations and SCIM. Here are resources to help you understand and...

Digital Asset Management APIs

Digital Asset Management APIs You can use headless APIs to interface with Liferay's documents and media. Here are resources to help you understand and integrate these APIs.

Object API Basics

Official Documentation

Object API Basics When you publish an object, Liferay generates REST APIs for it automatically. These APIs differ for Company and Site scoped objects, but they all use the c/[pluralobjectlabel]...

Managing Object Entries Using GraphQL

Official Documentation

Managing Object Entries Using GraphQL You can use GraphQL to manage custom object entries in Liferay efficiently. This API framework simplifies data interaction and serves as an alternative to REST...

SCIM User API Basics

Official Documentation

SCIM User API Basics Liferay DXP 2024.Q1+/Portal GA112+ Liferay provides a headless API to perform CRUD operations on SCIM users to keep their identity information in sync with your company's...

Custom Object APIs

Official Documentation

Custom Object APIs Liferay 7.4+ When you publish a custom object definition, Liferay generates default REST APIs for interacting with the object and its data. These APIs vary depending on the...

SCIM Group API Basics

Official Documentation

SCIM Group API Basics Liferay DXP 2024.Q1+/Portal GA112+ Liferay provides a headless API to perform CRUD operations on SCIM groups to keep their information in sync with your company's...

SCIM Resource Type, Service Provider, and Schema Basics

Official Documentation

SCIM Resource Type, Service Provider, and Schema Basics Liferay DXP 2025.Q2+ Liferay provides a headless API to query the SCIM resource types, service providers, and schemas available. Use the...

Object APIs

Object APIs You can use headless APIs to interface with objects and picklists. Here are resources to help you understand and integrate these APIs to enhance your ability to manage objects.

Using nestedFields to Audit Entry History

Official Documentation

Using nestedFields to Audit Entry History Liferay 7.4 U72+/GA72+ When you enable entry history for an object definition, you can use the nestedFields parameter with REST APIs to audit entry...

Process Automation APIs

Process Automation APIs You can use headless APIs to interface with automation features in Liferay DXP, including workflows. Here are resources to help you understand and integrate these APIs to...

Using Object APIs With Base64 Encoded Files

Official Documentation

Using Object APIs With Base64 Encoded Files Liferay DXP 2024.Q2+/Portal GA120+ When creating object entries with attachment fields through APIs, you can generally upload files from your computer...

Using Aggregation Terms with REST APIs

Official Documentation

Using Aggregation Terms with REST APIs When querying Object entries using REST APIs, you can use an Object's fields as facet criteria for aggregating entry data. To do this, add the...

Notifications API Basics

Official Documentation

Notifications API Basics Liferay's headless delivery application provides REST and GraphQL services for subscribing to or unsubscribing from notifications for platform events across several default...

Workflow Definition Link API Basics

Official Documentation

Workflow Definition Link API Basics Liferay DXP 2025.Q1+/Portal GA132+ You can manage workflow definition links from the Liferay UI or using Liferay's REST APIs. In Liferay, the Control Panel →...

Using nestedFields to Query Related Entries

Official Documentation

Using nestedFields to Query Related Entries Liferay 7.4 U69+/GA69+ The nestedFields parameter returns multiple levels of related object entries in a single GET request. Pass the nestedFields...

Picklists API Basics

Official Documentation

Picklists API Basics Liferay provides the headless-admin-list-types REST APIs for creating and managing picklist definitions (ListTypeDefinition) and their entries (ListTypeEntry). You can view and...

Using Relationship REST APIs

Official Documentation

Using Relationship REST APIs Liferay 7.4 U70+/GA70+ When you add relationships to custom or system objects, Liferay generates REST endpoints for accessing those relationships. You can relate and...

Using Batch APIs

Official Documentation

Using Batch APIs When you publish an Object, Liferay automatically generates REST APIs for it. These include the batch APIs for bulk POST, PUT, and DELETE operations. Here you'll use cURL commands...

Search API Basics

Official Documentation

Search API Basics Generally Available in Liferay DXP 2025.Q4+/Portal 2026.Q1+ You can search for content from a Liferay search page, but you can also use the /search API endpoints. If you're...

Search Suggestions API

Official Documentation

Search Suggestions API DXP 7.4 U36+/Portal GA36+ You can return suggestions using the /suggestions headless API. This API is used by Liferay's Search Bar Suggestions feature. There are two primary...

Search APIs

Official Documentation

Search APIs Generally Available in Liferay DXP 2025.Q4+/Portal 2026.Q1+ You can search with headless APIs using the endpoints at /o/search. These are the primary endpoints: Use the GET /search...

Migrating to Liferay Objects

Official Documentation

Migrating to Liferay Objects Dynamic Data Lists is deprecated and scheduled for removal by the end of 2024. To prevent data loss and achieve the same functionality, please migrate your structures...

Getting Started with Dynamic Data Lists

Official Documentation

Getting Started with Dynamic Data Lists Dynamic Data Lists is deprecated as of Liferay DXP 7.3, and is planned for removal in 2024. It is replaced by Objects. Please migrate your Dynamic Data...

Data Providers

Official Documentation

Data Providers Data providers serve data that can be consumed by the Forms application. The REST Data Provider is included with the Forms application. With it, you can consume data from REST web...

Dynamic Data Lists

Official Documentation

Dynamic Data Lists Dynamic Data Lists is deprecated as of Liferay DXP 7.3, and is planned for removal in 2024. It is replaced by Objects. Please migrate your Dynamic Data Lists to Objects as soon...

Validation Conditions Reference

Official Documentation

Validation Conditions Reference There are several out-of-the-box validation conditions that can be used to validate form responses before they are submitted. Text Field Validation Conditions...

Creating Form Templates

Official Documentation

Creating Form Templates Dynamic Data Lists is deprecated as of Liferay DXP 7.3, and is planned for removal in 2024. It is replaced by Objects. Please migrate your Dynamic Data Lists to Objects as...

Creating Data Lists

Official Documentation

Creating Data Lists Dynamic Data Lists is deprecated as of Liferay DXP 7.3, and is planned for removal in 2024. It is replaced by Objects. Please migrate your Dynamic Data Lists to Objects as soon...

Managing Data Definitions

Official Documentation

Managing Data Definitions Dynamic Data Lists is deprecated as of Liferay DXP 7.3, and is planned for removal in 2024. It is replaced by Objects. Please migrate your Dynamic Data Lists to Objects...

Form Rules

Official Documentation

Form Rules The Forms application is in maintenance mode as of Liferay DXP 2024.Q4/Portal GA129. Migrate your forms to objects and form container fragments to future-proof your solutions. Forms...

Creating Display Templates

Official Documentation

Creating Display Templates Dynamic Data Lists is deprecated as of Liferay DXP 7.3, and is planned for removal in 2024. It is replaced by Objects. Please migrate your Dynamic Data Lists to Objects...

Using Templates to Display Forms and Lists

Official Documentation

Using Templates to Display Forms and Lists Dynamic Data Lists is deprecated as of Liferay DXP 7.3, and is planned for removal in 2024. It is replaced by Objects. Please migrate your Dynamic Data...

Configuring Form Notifications

Official Documentation

Configuring Form Notifications You can configure the Forms app to send a notification email each time a form entry is submitted. If you have enabled workflow for the form, you may not need to...

Search Results