Reference

Get analytics for a channel

Retrieves key performance metrics like follower growth, impressions, and engagement for a connected social media channel, helping you monitor your online presence and track content performance over time

Get analytics for a post

Pull engagement metrics for a single published post

List connected channels

Returns a list of all social media channels connected to your organization, including each channel's ID, platform, and profile details. Use this to retrieve channel identifiers needed for scheduling posts, fetching analytics, or managing integration settings.

Check API key connection

Verifies that your API key is valid and active, serving as a quick health check to ensure your Postiz integration is ready to use before making other requests.

Disconnect a channel

Disconnect a channel by its integration ID. Any scheduled posts tied to this channel are also deleted, so use with care.

Find the next available posting slot

Return the next open time slot for a channel based on its configured posting schedule. Use this to auto-fill the publish date when queuing a new post so it respects the channel's cadence.

Get a channel's settings and tools

Retrieves the posting rules, content limits, and available tools for a connected social channel, so you can tailor your posts and decide which automation features to use.

Get OAuth URL to connect a channel

Generates an OAuth authorization URL for connecting a new social media channel. Use this URL to redirect users through the platform's authorization flow.

List customer groups

Return all customer groups in your organization. Groups (shown as customers in the UI) let agencies segment channels by client; pass a group ID to filter the integrations list to a single customer.

Run a provider tool on a channel

Run a provider-specific tool on a connected social media channel—such as searching for audio, listing channels, or fetching flairs—to automate content preparation and channel management without switching platforms.

List notifications

Return your organization's notifications, newest first, paginated 100 per page. Use this to surface publishing failures, approvals, and other account events in your own dashboard.

Change a post between draft and scheduled

Move a post between draft and scheduled

Create or schedule a post

Create or schedule a post across one or more connected channels

List posts in a date range

Returns all scheduled and published posts within a specified date range, allowing you to review your content calendar and audit what has been queued or published.

Delete a post

Delete a post by its ID. Postiz resolves the post's group and deletes all posts in the same group, so sibling posts published to other channels are removed too.

Delete posts by group

Removes the entire batch of posts that were published together across multiple channels, allowing you to delete a cross-platform campaign or scheduled group in a single action.

Get missing published content

When a post was published but the platform did not return a usable post ID (its `releaseId` is `"missing"`), this fetches recent content from the provider so you can match and link the correct item. Requires the provider to implement the optional `missing` method; otherwise an empty array is returned. Follow up with the release ID endpoint to connect the match.

Link a post to its published content

Set the `releaseId` of a post whose release ID is currently `"missing"`, connecting it to the actual published content on the platform so analytics and statistics can be tracked. Typically called after the missing-content endpoint returns the available items to choose from.

Upload media from a URL

Directly import images or videos from web URLs into your media library, automatically generating a reusable reference for your social media posts.

Upload a media file

Upload an image or video as multipart form data. The response returns the stored media reference to attach when creating a post.

Generate an AI video

Create an AI-generated video to attach to a post, either from image-and-text slides or a text prompt. Returns the generated media so you can include it when scheduling a post.

Run a video helper function

Retrieves available options like voices, styles, or templates needed to configure AI video generation.