liferay-headless-apis

Consume and extend Liferay Headless REST and GraphQL APIs for portal data access.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/JoaoPedroAmaral/backBarbearia --skill liferay-headless-apis
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: liferay-headless-apis
Source: https://github.com/JoaoPedroAmaral/backBarbearia/tree/main/.claude/skills/liferay-headless-apis
Command: npx skills add https://github.com/JoaoPedroAmaral/backBarbearia --skill liferay-headless-apis

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Provides concise, practical guidance for consuming and extending Liferay's Headless REST and GraphQL APIs so developers can retrieve and manipulate portal content, users, taxonomy, and commerce data without building custom backend endpoints.

Core Features & Use Cases

  • Authentication & Access: Shows how to use OAuth2 bearer tokens and when Basic Auth is acceptable for development.
  • Querying & Pagination: Explains OData filter expressions, sort, page, pageSize, fields selection, nestedFields, and best practices to minimize payloads.
  • GraphQL & Batch Operations: Describes using the /o/graphql endpoint, namespaced queries, and batch endpoints for bulk create/update flows.
  • Use Case: Integrate a React frontend to list structured content for a site, filter by category, and fetch nested creator details with minimal API calls.

Quick Start

List the first page of structured contents for site 20117 using an OAuth2 bearer token and return id, title, and dateCreated fields only.

Frequently Asked Questions about liferay-headless-apis

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I authenticate requests to Liferay headless APIs?

Liferay headless APIs authenticate requests using OAuth2 bearer tokens for production environments, while Basic Auth is acceptable for local development scenarios.

How do I filter and paginate Liferay REST API responses?

Liferay REST APIs use OData parameters for filtering, sorting, and pagination. You can apply filter expressions, page, pageSize, and fields selection to minimize payload sizes.

Can I use GraphQL to query structured content in Liferay DXP?

Liferay DXP supports GraphQL queries via the /o/graphql endpoint. You can execute namespaced queries to fetch structured content and nested creator details with minimal API calls.

Does Liferay support batch operations for bulk content updates?

Liferay provides batch endpoints for bulk create and update flows. These endpoints allow automation workflows to manipulate portal content and commerce data efficiently.

What is the best way to fetch nested creator details with Liferay APIs?

To fetch nested creator details, use the nestedFields parameter in Liferay REST APIs or GraphQL queries. This approach minimizes API calls by retrieving related data in a single request.

When should I use Basic Auth instead of OAuth2 with Liferay APIs?

Basic Auth should only be used during local development for convenience. OAuth2 bearer tokens are required for securing Liferay headless API access in production scenarios.