Payload CMS

Interact with Payload CMS collections and globals
Join our community

Actions18

Overview

This node interacts with Payload CMS to perform operations on collections, globals, and authentication. Specifically, the 'Find' operation under the 'Collection' resource allows users to query documents within a specified collection. It supports filtering, pagination, sorting, field selection, and localization, making it useful for retrieving structured content from Payload CMS in various scenarios such as content management, data integration, and automation workflows.

Use Case Examples

  1. Retrieve a list of blog posts with pagination and sorting by creation date.
  2. Filter products in an e-commerce collection based on category and price range.
  3. Fetch localized content for a specific locale from a collection.

Properties

Name Meaning
Collection The specific collection in Payload CMS to query documents from.
Additional Options Optional parameters to customize the query such as depth of relationship population, limit on number of documents, pagination page number, sorting field, filtering conditions (where clause), selected fields, and locale for localized content.

Output

JSON

  • json - The JSON response containing the documents found in the specified collection, including any applied filters, pagination, sorting, and selected fields.

Dependencies

  • Requires an API key credential for Payload CMS to authenticate requests.

Troubleshooting

  • Authentication failures due to invalid or expired API credentials. Ensure the API key is valid and the Payload CMS instance is accessible.
  • Errors parsing the 'Where' JSON filter if the input is malformed. Validate JSON syntax before input.
  • Pagination or limit parameters may result in empty responses if page number or limit is set incorrectly.
  • Network or connectivity issues with the Payload CMS instance can cause request failures.

Links

Discussion