Search Results

All Results 1936
Sort By
Resource Type
Deployment Approach
Capability
Feature
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...
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]...
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...
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...
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...
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...
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...
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 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...
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 →...
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...
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...
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...
Account Groups API Basics
Official Documentation
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. ...
Countries API Basics
Official Documentation
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. ...
Navigation Menu API Basics
Official Documentation
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...
User Management APIs
Official Documentation
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...
Account Users and Roles APIs
Official Documentation
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...
Adding the UAD Framework
Official Documentation
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....
Managing Object Entry Versions
Official Documentation
Managing Object Entry Versions Liferay DXP 2025.Q4+ Liferay's Content Management System (CMS) uses object entry versioning. In Liferay DXP 2026.Q3 and later, object entry versioning is available...
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...
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...
Postal Address API Basics
Official Documentation
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...
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...
API Query Parameters
Official Documentation
API Query Parameters Whether you consume REST APIs or GraphQL APIs, different query parameters are available to help you filter the responses. Some endpoints do not make use of the filter, sort,...
User Account API Basics
Official Documentation
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...
Regions API Basics
Official Documentation
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...
Consuming APIs
Official Documentation
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,...
Roles API Basics
Official Documentation
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,...
API Headers Reference
Official Documentation
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...
Batch Engine API Basics - Importing Data
Official Documentation
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...
Batch Engine API Basics - Exporting Data
Official Documentation
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,...
Consuming REST Services
Official Documentation
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: ...
Using External Reference Codes
Official Documentation
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...
Data Migration Center
Official Documentation
Data Migration Center Liferay DXP 2023.Q4+/Portal GA102+ [Beta Feature](../../../../security-and-administration/administration/configuring-liferay/feature-flags.md#beta-feature-flags) Currently,...
Consuming GraphQL APIs
Official Documentation
Consuming GraphQL APIs Liferay DXP contains GraphQL APIs for most of its applications. The GraphQL APIs are available at http://[host]:[port]/o/graphql. Here's how to consume them in three steps: ...
Using OAuth 2.0
Official Documentation
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...
Configuring JSON Web Services
Official Documentation
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...
Notifications
Official Documentation
Notifications Liferay provides integrated notification tools to alert users to platform events. For Liferay DXP, this includes email and website notifications for the following default...
Using Forms to Poll Users
Official Documentation
Using Forms to Poll Users 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...
Actions
Official Documentation
Actions Object actions define custom business logic that you can run manually or automatically for object entry events. Examples include delivering entry event data to a webhook URL, sending email...
Using Manual Actions
Official Documentation
Using Manual Actions Liferay 7.4 U60+/GA60+ When you use the standalone trigger for object actions, the actions become manual instead of automatic. Trigger these actions using these methods: ...
Understanding Action Types
Official Documentation
Understanding Action Types Liferay 7.4 U60+/GA60+ Actions define custom operations triggered by object entry events. Liferay provides these action types: TypeDescription NotificationSend email or...
Creating and Managing Objects
Official Documentation
Creating and Managing Objects Liferay 7.4+ Liferay Objects provides a convenient UI for creating custom applications that meet your business needs without writing code. You can also use Objects to...
Objects
Official Documentation
Objects Liferay 7.4+ With Liferay Objects, you can build and deliver applications without having to write code or deploy modules. Each application built with Objects is integrated with Liferay's...
Fields
Official Documentation
Fields Liferay DXP 2023.Q4+/Portal GA102+ Object fields are data definitions that represent database columns and store different types of values. All objects include default system fields, but you...
Extending Unmodifiable System Objects
Official Documentation
Extending Unmodifiable System Objects Liferay 7.4 U86+/GA86+ With Liferay Objects, you can extend supported system services. These services are integrated with the Objects framework as...
Auditing Object Events
Official Documentation
Auditing Object Events Liferay 7.4 U72+/GA72+ You can use Liferay's audit framework to track events for custom object definitions and their entries. To track entry events, you must enable entry...
Email Address Fields
Official Documentation
Email Address Fields Liferay DXP 2026.Q3+ Email Address fields store and validate email addresses entered on forms and through the API. Objects normalizes every value to lowercase before storage,...
Formula Fields
Official Documentation
Formula Fields Liferay DXP 2023.Q4+/Portal GA102+ Formula fields provide read-only values calculated using numeric fields in the object definition. Unlike other fields, formula values are...
Auto-Increment Fields
Official Documentation
Auto-Increment Fields DXP 2024.Q1+/Portal GA112+ Auto-Increment fields are configurable read-only fields for uniquely identifying object entries in a human-readable format. For example, an IT...
Aggregation Fields
Official Documentation
Aggregation Fields Liferay 7.4 U47+/GA47+ Aggregation fields perform basic calculations on the entries from a relationship table and display the resulting values. Available aggregation functions...
Encrypted Fields
Official Documentation
Encrypted Fields Self-Hosted and PaaS Only Liferay 7.4 U72+/GA72+ Liferay provides the encrypted field type for storing sensitive user data. To use encrypted fields, first add an encryption...
Assignee Fields
Official Documentation
Assignee Fields Liferay DXP 2025.Q4+/Portal 2026.Q1+ Assignee fields are for selecting existing users or roles in the object entry. Assigned users can edit the entry with no manual permission...
Adding Fields to Objects
Official Documentation
Adding Fields to Objects Liferay DXP 2023.Q4+/Portal GA102+ Fields are data definitions that represent database columns and store different types of values. By default, all objects include these...
Attachment Fields
Official Documentation
Attachment Fields Attachment fields are for uploading files to your instance's Document Library. When uploaded, the file is linked to the entry's attachment field. Each field can only be linked to...
Phone Number Fields
Official Documentation
Phone Number Fields Liferay DXP 2026.Q3+ Phone Number fields store contact numbers with built-in validation and normalization. All values are stored in E.164 format (a + followed by 7–15 digits,...
Picklist Fields
Official Documentation
Picklist Fields Liferay 7.4 U72+/GA72+ Picklists define lists of text values usable as single select or multi-select fields in object definitions. By default, single select fields appear as...

Showing 961 to 1,020 of 2,249 entries.