Skip to main content
This API is currently in Beta and in active development. It does not provide all Postiz features yet.

​
SDKs & Integrations

NodeJS SDK

Official Postiz NodeJS SDK

n8n Node

Custom n8n node for Postiz

​
Authentication

All API requests require an API key. Get your API key from Postiz Settings. Include the API key in the Authorization header: 
curl -H "Authorization: your-api-key" https://api.postiz.com/public/v1/integrations

​
Base URL

EnvironmentBase URL
Postiz Cloudhttps://api.postiz.com/public/v1
Self-hostedhttps://{NEXT_PUBLIC_BACKEND_URL}/public/v1

​
Rate Limits

30 requests per hour limit applies to all endpoints.This doesn’t mean you can only post 30 times per hour—each API call counts as one request. Schedule multiple posts in a single request to maximize throughput.

​
Terminology

The Postiz UI uses the term channel, while the API uses integration. They refer to the same thing—a connected social media account.

​
Supported Platforms (27 total)

When creating posts, each social media platform has its own settings schema. The settings object must include a __type field matching the provider.

​
Platforms with custom settings (21)

  • Social
  • Video
  • Community
  • Design
  • Blogging
  • Business
Platform__typeKey settings
X (Twitter)xwho_can_reply_post, community
LinkedInlinkedinpost_as_images_carousel
LinkedIn Pagelinkedin-pagepost_as_images_carousel
Facebookfacebookurl (optional)
Instagram (FB-linked)instagrampost_type, collaborators
Instagram Standaloneinstagram-standalonepost_type, collaborators
Warpcast (Farcaster)warpcastsubreddit[] (channels)

​
Platforms without custom settings (6)

These platforms only require { "__type": "platform-name" }:
Platform__type
Threadsthreads
Mastodonmastodon
Blueskybluesky
Telegramtelegram
Nostrnostr
VKvk

View Provider Settings Reference

See detailed settings schemas with examples for each platform

​
Quick Examples

​
Schedule a post to X (Twitter)

{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": { "id": "your-integration-id" },
      "value": [
        {
          "content": "Hello from the Postiz API! 🚀",
          "image": []
        }
      ],
      "settings": {
        "__type": "x",
        "who_can_reply_post": "everyone"
      }
    }
  ]
}

​
Post immediately to LinkedIn

{
  "type": "now",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": { "id": "your-linkedin-id" },
      "value": [
        {
          "content": "Exciting announcement! 🎉",
          "image": []
        }
      ],
      "settings": {
        "__type": "linkedin"
      }
    }
  ]
}

​
Upload an image and post to Instagram

# Step 1: Upload the image
curl -X POST "https://api.postiz.com/public/v1/upload" \
  -H "Authorization: your-api-key" \
  -F "file=@photo.jpg"

# Response: { "id": "img-123", "path": "https://uploads.postiz.com/photo.jpg", ... }

# Step 2: Create the post with the uploaded image
curl -X POST "https://api.postiz.com/public/v1/posts" \
  -H "Authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "schedule",
    "date": "2024-12-14T10:00:00.000Z",
    "shortLink": false,
    "tags": [],
    "posts": [{
      "integration": { "id": "your-instagram-id" },
      "value": [{
        "content": "Beautiful sunset 🌅 #photography",
        "image": [{ "id": "img-123", "path": "https://uploads.postiz.com/photo.jpg" }]
      }],
      "settings": {
        "__type": "instagram",
        "post_type": "post"
      }
    }]
  }'

​
Publish a Medium article

{
  "type": "now",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": { "id": "your-medium-id" },
      "value": [
        {
          "content": "# Introduction\n\nThis is my article in markdown...",
          "image": []
        }
      ],
      "settings": {
        "__type": "medium",
        "title": "My Amazing Article",
        "subtitle": "A deep dive into something interesting",
        "tags": [
          { "value": "programming", "label": "Programming" }
        ]
      }
    }
  ]
}

​
Create a Google My Business offer

{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": { "id": "your-gmb-id" },
      "value": [
        {
          "content": "🎉 Holiday Sale! 20% off everything!",
          "image": []
        }
      ],
      "settings": {
        "__type": "gmb",
        "topicType": "OFFER",
        "callToActionType": "GET_OFFER",
        "callToActionUrl": "https://example.com/sale",
        "offerCouponCode": "HOLIDAY20"
      }
    }
  ]
}