Search Results

All Results 7003
Sort By
Resource Type
Applicable Versions
Deployment Approach
Capability
Feature
Creating External Video Shortcuts
Official Documentation
Creating External Video Shortcuts Liferay 7.4+ With Liferay's Documents and Media application, you can save references to videos hosted on external platforms. These references can then be used to...
Using Folders
Official Documentation
Using Folders By default, uploaded files are stored in the Documents and Media root folder (i.e., Home), but you can create additional folders to organize and manage your files. Each folder can...
Creating Your First Site
Official Documentation
Creating Your First Site Sites are collections of pages that contain and display content. This article walks through creating a new Site based on an existing out-of-the-box template. Creating a...
Starting with a Docker Image
Official Documentation
Starting with a Docker Image The latest versions of Liferay are available as Docker images on Docker Hub. They're in two categories: Liferay/Portal Liferay/DXP Follow the steps below to...
Querying Data
Official Documentation
Querying Data The root endpoint of Liferay Analytics Cloud is . You can get the list of all data types endpoints by requesting a GET to the above URL. Try with curl curl -i -L -H "Authorization:...
Building a Sample API Application
Official Documentation
Building a Sample API Application Liferay DXP 2023.Q4+/Portal GA102+ [Beta Feature](../../security-and-administration/administration/configuring-liferay/feature-flags.md#beta-feature-flags) The...
Warehouse API Basics
Official Documentation
Warehouse API Basics You can manage warehouses from the Applications menu or REST APIs. Call the headless-commerce-admin-inventory services to create and manage warehouses. Adding a Warehouse ...
Exporting Data
Official Documentation
Exporting Data Various analytics data can be accessed through the sites dashboard and the individuals dashboard. Analytics data can also be fetched and exported using Analytics Cloud's APIs....
Term API Basics
Official Documentation
Term API Basics You can manage terms and conditions from the Applications menu or with REST APIs. Use the /terms endpoint from headless-admin-commerce-order to create and manage terms and...
Discount API Basics
Official Documentation
Discount API Basics You can manage discounts from the Applications menu or with REST APIs. Call the headless-admin-commerce-pricing services to create and manage discounts. Adding a Discount Once...
Currency API Basics
Official Documentation
Currency API Basics Liferay DXP 2024.Q1+/Portal GA112+ You can manage currencies from the Applications menu or with REST APIs. Call the headless-commerce-admin-catalog services to create and...
Product API - Creating a Product with Multiple SKUs
Official Documentation
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...
Order API Basics
Official Documentation
Order API Basics You can manage orders from the Applications menu or with REST APIs. Call the headless-admin-commerce-order services to create and manage orders. Adding an Order Once Liferay is...
Catalog API Basics
Official Documentation
Catalog API Basics You can manage catalogs from the Applications menu or REST APIs. Call the headless-commerce-admin-catalog services to create and manage catalogs. Adding a Catalog Once Liferay...
Option API Basics
Official Documentation
Option API Basics You can manage option templates from the Applications menu or with REST APIs. Call the headless-commerce-admin-catalog services to create and manage options. Adding an Option ...
Order Type API Basics
Official Documentation
Order Type API Basics You can manage order types from the Applications menu or with REST APIs. Use the /order-types endpoint from headless-admin-commerce-order to create and manage order types. ...
Price List API Basics
Official Documentation
Price List API Basics You can manage price lists from the Applications menu or with REST APIs. Call the headless-admin-commerce-pricing services to create and manage price lists. Adding a Price...
Option Value API Basics
Official Documentation
Option Value API Basics You can manage option values from the Options application or with REST APIs. Call the headless-commerce-admin-catalog services to create and manage option values. Adding an...
Specification API Basics
Official Documentation
Specification API Basics You can manage product specifications from the Applications menu or with REST APIs. Call the headless-commerce-admin-catalog services to create and manage specifications. ...
Channel API Basics
Official Documentation
Channel API Basics You can manage channels from the Applications menu or with REST APIs. Call the headless-commerce-admin-channel services to create and manage channels. Adding a Channel Once...
Knowledge Base API Basics
Official Documentation
Knowledge Base API Basics You can Create Knowledge Base Articles and Manage the Knowledge Base with Liferay's Knowledge Base app, but you can also use Liferay's REST APIs. Call these services to...
Blog API Basics
Official Documentation
Blog API Basics Liferay's REST APIs provide services for adding, modifying, and deleting blog posts and images. Liferay DXP 2024.Q4+/Portal GA129+ The Blogs API now uses External Reference Codes...
Product Delivery API Basics
Official Documentation
Product Delivery API Basics Product API Basics covers the admin API used for creating and managing products. To display product data in your storefront, you must use the Product Delivery API. Call...
Advanced Web Content API
Official Documentation
Advanced Web Content API Using the Liferay DXP REST services, you can create and manage your site's structured content. Structured content is web content that uses a web content structure (or...
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...
Web Content API Basics
Official Documentation
Web Content API Basics Using Liferay DXP REST services, you can create and manage structured content on your site. Structured content refers to web content articles that use a web content structure...
Web Content API Basics Using GraphQL
Official Documentation
Web Content API Basics Using GraphQL Use Liferay DXP GraphQL services to manage web content by creating, retrieving, updating, and deleting structured content on your site. Structured content...
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.
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...
Managing Web Content Structures and Templates by Using the REST API
Official Documentation
Managing Web Content Structures and Templates by Using the REST API Web content structures define the information included in a web content article. Structures facilitate creating and managing web...
Message Boards API Basics
Official Documentation
Message Boards API Basics Liferay's Headless Delivery application provides REST services for the Message Boards application. With these services, you can add message board categories, threads, 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...
Workflow Notification Template Variables
Official Documentation
Workflow Notification Template Variables Liferay 7.3+ Some variables are auto-injected into the workflow notification context. These are handy to use in your workflow notification templates. ...
Workflow Task Node Reference
Official Documentation
Workflow Task Node Reference As of DXP 2024.Q3, scripting is disabled by default. You can enable it in System Settings → Script Management (under the Security category). Tasks are the part of the...
Working with Workflow Context
Official Documentation
Working with Workflow Context Workflows in Liferay are used as approval processes. At each step of the process, the workflow has certain data that's available in a Map object referred to in your...
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...
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 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 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...
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...
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 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...
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...
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...
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 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...
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 →...
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. Fields Parameter Use this parameter to specify and...
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: ...
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...
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....
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...
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. ...
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...
Accounts API Basics
Official Documentation
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 ...
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. ...