Capability

Sites

Liferay sites are customizable spaces for building personalized digital experiences. Each site includes applications for creating content, designing pages, and more. With these features, you can bring your custom solutions to life, whether intranets, public sites, customer portals, or e-commerce storefronts. In fact, you can leverage Liferay's multi-site capabilities to create multiple such sites in the same Liferay instance.

Feature
Deployment Approach
Capability
Document API Basics
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...
Published Date: May 9, 2024 6:50 PM
Document Types and Metadata Sets API Basics
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...
Published Date: Jan 30, 2025 12:26 PM
Document Shortcut API Basics
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,...
Published Date: Jul 11, 2024 3:36 PM
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...
Published Date: Jun 28, 2025 6:30 PM
SCIM Group API Basics
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...
Published Date: May 9, 2024 6:52 PM
Captcha API Basics
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...
Published Date: May 9, 2024 6:52 PM
Search APIs
Search APIs You can search with headless APIs using the endpoints at /o/search. Search Headless APIs Availability The first search headless endpoint, /portal-search-rest, was released behind a...
Published Date: May 9, 2024 6:59 PM
Search API Basics
Search API Basics [Release Feature](../../../security-and-administration/administration/configuring-liferay/feature-flags.md#release-feature-flags) 7.4 U88+ and GA88+ You can search for content...
Published Date: Sep 7, 2024 3:46 PM
SCIM Resource Type, Service Provider, and Schema Basics
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...
Published Date: May 27, 2025 3:40 PM
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...
Published Date: Jun 28, 2025 6:30 PM
Search Suggestions API
Search Suggestions API DXP 7.4 U36+/Portal GA36+ You can return suggestions with the using the /suggestions headless API. This API is used by Liferay's Search Bar Suggestions feature. There are...
Published Date: Sep 7, 2024 3:46 PM
Workflow Definition Link API Basics
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 →...
Published Date: Feb 19, 2025 12:28 PM
SCIM User API Basics
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...
Published Date: May 9, 2024 6:52 PM
Navigation Menu API Basics
Navigation Menu API Basics Liferay's REST APIs provide services for Liferay's navigation menus. You can create and edit navigation menus with the API. Start by seeing an example of adding a new...
Published Date: May 9, 2024 6:58 PM
Account Groups API Basics
Account Groups API Basics Liferay DXP/Portal 7.4+ You can manage account groups from the Applications menu or use Liferay's REST APIs. Call these services to create and manage account groups. ...
Published Date: Feb 13, 2025 12:50 PM
Site APIs
Site APIs Use Liferay’s REST APIs to manage site elements programmatically. This guide introduces the Navigation Menu API and shows how to create, retrieve, update, and delete navigation menus...
Published Date: May 9, 2024 6:58 PM
User Management APIs
User Management APIs You can use headless APIs to interface with important Liferay user management features, including user accounts, organizations, and roles. Here are resources to help you...
Published Date: May 9, 2024 6:59 PM
Organizations API Basics
Organizations API Basics You can Create and Manage Organizations from the Application menu, but you can also use Liferay's REST APIs. Call these services to manage organizations. Adding an...
Published Date: May 9, 2024 6:59 PM
Account Users and Roles APIs
Account Users and Roles APIs You can manage Account Users and Account Roles from the Applications menu, but you can also use Liferay's REST APIs. Call these services to create and manage account...
Published Date: May 9, 2024 6:59 PM
Countries API Basics
Countries API Basics Liferay 7.4 U24+ and GA24+ Use Liferay's Rest APIs to create and manage countries. Adding a Country Then, follow these steps: Download and unzip Countries API Basics. ...
Published Date: May 9, 2024 6:59 PM
Postal Address API Basics
Postal Address API Basics Liferay DXP/Portal 7.4+ Use Liferay's REST APIs to manage postal addresses. Add Postal Address to Account Then, follow these steps: Download and unzip Postal Address...
Published Date: May 9, 2024 6:59 PM
Accounts API Basics
Accounts API Basics Liferay DXP/Portal 7.4+ You can manage accounts from the Applications menu or use Liferay's REST APIs. Call these services to create and manage accounts. Adding an Account ...
Published Date: Feb 12, 2025 1:01 PM
Adding the UAD Framework
Adding the UAD Framework You can manage and delete user data with Liferay's User Associated Data (UAD) management tool. The tool is available out-of-the-box for many of Liferay's applications (e.g....
Published Date: May 9, 2024 6:59 PM
Regions API Basics
Regions API Basics Liferay 7.4 U24+ and GA24+ Use Liferay's REST APIs to create and manage regions. Adding a Region Then, follow these steps: Download and unzip Regions API Basics. curl...
Published Date: May 9, 2024 6:59 PM
User Groups API Basics
User Groups API Basics You can Create and Manage User Groups from the Application menu, but you can also use Liferay's REST APIs. Call these services to manage user groups. Adding a User Group ...
Published Date: May 9, 2024 6:59 PM
User Account API Basics
User Account API Basics You can add and manage users from the Control Panel, but you can also use Liferay's REST APIs. You can call these services to add, edit, delete users. Start with adding a...
Published Date: Nov 22, 2024 10:53 PM
Roles API Basics
Roles API Basics You can create and manage roles from the Application menu, but you can also use Liferay's REST APIs. Call these services to manage roles. Associate a User to a Regular Role Then,...
Published Date: May 9, 2024 6:59 PM
API Query Parameters
API Query Parameters Whether you consume REST APIs or GraphQL APIs, different query parameters are available to help you filter the responses. Fields Parameter Use this parameter to specify and...
Published Date: May 9, 2024 6:51 PM
Consuming APIs
Consuming APIs APIs, or Application Programming Interfaces, serve as the bridge between different software applications, allowing them to communicate and exchange data. By consuming external APIs,...
Published Date: May 9, 2024 6:51 PM
API Headers Reference
API Headers Reference API headers are components of HTTP requests that provide essential information to the server about the client's request and how the server should handle it. You can use API...
Published Date: May 9, 2024 6:51 PM
Using Liferay as a Headless Platform
Using Liferay as a Headless Platform Liferay provides a suite of APIs that perform the same kinds of actions available in the web interface. This is essential when you must get data in a...
Published Date: May 9, 2024 6:51 PM
Batch Engine API Basics - Exporting Data
Batch Engine API Basics - Exporting Data Liferay's Headless Batch Engine provides REST APIs to import and export data. Call these services to export data from Liferay. Exporting Data Then,...
Published Date: May 9, 2024 6:51 PM
Consuming REST Services
Consuming REST Services Liferay DXP contains REST services for most of its applications. These services are fully OpenAPI compliant. Here, learn how to consume them. This takes only three steps: ...
Published Date: May 9, 2024 6:51 PM
Configuring JSON Web Services
Configuring JSON Web Services Liferay’s services are exposed as JSON web services out-of-the-box. This is enabled by default. You can access these services via the API page at...
Published Date: Nov 16, 2024 3:32 PM
Consuming GraphQL APIs
Consuming GraphQL APIs Liferay DXP contains GraphQL APIs for most of its applications. Here's how to consume them in three steps: Identify the API you wish to consume. Identify the site...
Published Date: May 9, 2024 6:51 PM
Batch Engine API Basics - Importing Data
Batch Engine API Basics - Importing Data Liferay's Headless Batch Engine provides REST APIs to import and export data. Call these services to import data to Liferay. Importing Data Then follow...
Published Date: May 9, 2024 6:51 PM
Sample API Tutorials
Sample API Tutorials Follow the links below for sample API tutorials that include example requests and example code. Building Applications (Objects) Custom Objects API Basics Custom Objects...
Published Date: May 9, 2024 6:51 PM
Using External Reference Codes
Using External Reference Codes Liferay DXP/Portal 7.4+ Many of Liferay's headless API endpoints support an external reference code (ERC). The ERC field is useful in wide range of scenarios. For...
Published Date: May 9, 2024 6:51 PM
Making Unauthenticated Requests
Making Unauthenticated Requests By default, Liferay DXP restricts API access for the sake of security, requiring authentication to get a valid response. However, in certain cases it may make sense...
Published Date: May 9, 2024 6:51 PM
Using OAuth 2.0
Using OAuth 2.0 OAuth 2.0 is an industry-standard authorization protocol. Users with accounts on a Liferay-based website can share select credentials with various clients seamlessly. OAuth 2.0...
Published Date: May 9, 2024 6:51 PM