Postiz icon

Postiz

Consume Postiz API

Actions4

Overview

This node integrates with the Postiz API to manage social media posts and related content. It supports multiple operations including creating posts, deleting posts, retrieving posts, uploading files, and fetching connected integrations.

The Get Posts operation specifically allows users to retrieve a list of posts filtered by various time parameters (week, day, month, year) and optionally by customer ID. This is useful for scenarios such as:

  • Displaying scheduled or published posts for a specific week or day.
  • Generating reports or analytics on posts within a given timeframe.
  • Filtering posts by customer to manage multi-client social media accounts.

For example, a social media manager could use this node to fetch all posts scheduled for week 12 of 2025 or all posts for May 2025 to review content before publishing.

Properties

Name Meaning
Week Week number (1-52) to filter posts by week.
Day Day number (0-6) to filter posts by day, where 0 represents Sunday.
Display Display mode for posts; options are: day, week, or month.
Month Month number (1-12) to filter posts by month.
Year Year (2022-2035) to filter posts by year.
Customer Optional customer ID string to filter posts belonging to a specific customer.

These properties allow flexible filtering of posts based on time periods and customer association.

Output

The output is a JSON array containing the list of posts retrieved from the Postiz API according to the specified filters. Each item in the array represents a post object with its associated data as returned by the API.

The exact structure of each post object depends on the Postiz API response but typically includes details such as post content, scheduling information, tags, integration/channel IDs, and other metadata.

No binary data is output for the Get Posts operation.

Dependencies

  • Requires an API key credential for authenticating requests to the Postiz API.
  • Uses the form-data package internally for file uploads (not relevant for Get Posts).
  • The node expects proper configuration of the API authentication credentials in n8n.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication errors.
    • Providing out-of-range values for week (not between 1-52), day (not between 0-6), month (not between 1-12), or year (outside allowed range) may result in API errors or empty results.
    • Incorrect customer ID may lead to no posts being returned.

  • Error messages:

    • Errors from the API are caught and returned in the output as an error object with a description or message.
    • Network or connectivity issues will also be surfaced as error messages.

  • Resolution tips:

    • Verify that the API key credential is correctly set up and has necessary permissions.
    • Ensure input property values fall within the specified ranges.
    • Confirm the customer ID is valid if used.

Links and References

Discussion