Search Results

All Results 6987
Resource Type
Applicable Versions
Deployment Approach
Capability
Feature
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...
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...
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 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...
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 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...
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...
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...
Object API Basics
Official Documentation
Object API Basics When you publish an Object, Liferay automatically generates REST APIs for it. These APIs differ for Company and Site scoped Objects, but they all use the c/[pluralobjectlabel]...
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...
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...
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...
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 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...
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...
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...
Search API Basics
Official Documentation
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...
Search Suggestions API
Official Documentation
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...
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...
Search APIs
Official Documentation
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...
Site APIs
Official Documentation
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...
Managing Blog Entries
Official Documentation
Managing Blog Entries Bloggers and blog administrators manage blog entries using the Blogs application in the Site Administration menu. To access this app, open the Product Menu (Product Menu) and...
Exporting/Importing Calendar Data
Official Documentation
Exporting/Importing Calendar Data You can export and import calendar data as Liferay Archive (LAR) files. Data can only be ported between installations of the same version. Use the widget...
Configuring the Calendar Widget
Official Documentation
Configuring the Calendar Widget Use the Calendar widget configuration options to tailor the display and functionality of your calendar. From choosing the time format and default view to setting the...
Mapping Calendar Event Fields to Display Page Templates
Official Documentation
Mapping Calendar Event Fields to Display Page Templates You can customize and display calendar event information by mapping calendar fields to display page templates. Highlight certain fields such...
Displaying Blogs
Official Documentation
Displaying Blogs Liferay provides two ways to display blog entries: display page templates and the Blogs widget. Using Display Page Templates You can use display page templates to create reusable,...
Deprecated Content Features
Official Documentation
Deprecated Content Features These content features are deprecated and no longer actively developed in Liferay. While still available for compatibility and migration purposes, they are not...
Creating Message Boards Threads
Official Documentation
Creating Message Boards Threads A thread is a series of messages focused on a specific topic. It starts with an initial post, followed by replies that form a discussion. Only authenticated users...
Content Dashboard Interface
Official Documentation
Content Dashboard Interface Available 7.3+ The Content Dashboard user interface has three main sections: Content Audit Tool Contents List Content Info Sidebar To access the dashboard, open...
Exporting Assets List To a Spreadsheet
Official Documentation
Exporting Assets List To a Spreadsheet The Content Dashboard can export a spreadsheet (.xls file) of content related metadata for further analysis. To export the asset list to a spreadsheet, ...
Message Boards
Official Documentation
Message Boards Message Boards is deprecated as of Liferay DXP 2024.Q4/Portal GA129. For data continuity, consider transitioning to the Questions widget. Liferay's Message Boards application is a...
Message Boards Configuration Reference
Official Documentation
Message Boards Configuration Reference Configuration settings for the Message Boards app are divided in Settings and Notifications. To access the Message Boards app's configuration screen, Open...
Message Boards Permissions Reference
Official Documentation
Message Boards Permissions Reference Permissions settings for the Message Boards app include Home Category, Widget, General Category, and Thread permissions. Manage these settings to control user...
Subscribing to a Message Board
Official Documentation
Subscribing to a Message Board Users can receive email updates and in-product notifications by subscribing to a message board. By default, users are subscribed automatically to any threads they...
Message Boards Widget UI Reference
Official Documentation
Message Boards Widget UI Reference Explore the user interface elements of the Message Boards widget, including the various tabs and their functionalities. Each tab provides access to different...
Moderating Message Boards
Official Documentation
Moderating Message Boards Message boards include features that enable effective forum moderation. This includes thread locking, thread moving and merging, user bans, and thread flagging. Users with...
Wiki
Official Documentation
Wiki 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 Content. The...
Calendar
Official Documentation
Calendar The Calendar widget stores and shares scheduled events. It's a personal planner for individual users, a shared calendar for an entire site, or both at the same time. In addition to...
Highlighting Recent Bloggers
Official Documentation
Highlighting Recent Bloggers You can use the Recent Bloggers widget to highlight the work of your most recent blog authors. This widget lists each recent author's name, profile picture, and number...