Payload CMS

Interact with Payload CMS collections and globals
Join our community

Actions18

Overview

This node interacts with Payload CMS to perform operations on global data. Specifically, the 'Get' operation retrieves data from a specified global in the Payload CMS instance. It supports additional options such as depth of relationship population, pagination, sorting, filtering, field selection, and locale specification. This node is useful for workflows that need to fetch and utilize global configuration or content data stored in Payload CMS, such as site-wide settings or shared content blocks.

Use Case Examples

  1. Fetching site-wide settings stored as a global in Payload CMS to use in a website deployment workflow.
  2. Retrieving localized global content for multi-language websites.
  3. Getting filtered and paginated global data for reporting or integration purposes.

Properties

Name Meaning
Global The specific global data entity in Payload CMS to retrieve.
Additional Options Optional parameters to customize the data retrieval, including depth of relationship population, limit on number of documents, pagination page number, sorting field, filtering criteria (where clause), selected fields, and locale for localized content.

Output

JSON

  • json - The JSON response containing the requested global data from Payload CMS.

Dependencies

  • Requires an API key credential for Payload CMS authentication.

Troubleshooting

  • Authentication failures due to invalid or expired API credentials. Ensure the API key is correct and has not expired.
  • Errors parsing the 'Where' JSON filter option. Verify the JSON syntax is correct.
  • Network or connectivity issues with the Payload CMS instance. Confirm the base URL and API prefix are correct and the server is reachable.
  • Invalid global slug selection. Ensure the chosen global exists in the Payload CMS instance.

Links

Discussion