API operational
Documentation / Quickstart

From API key to verified delivery.

PostGate gives SaaS products one tenant-safe API for connecting customer accounts, publishing and scheduling content, tracking provider delivery, measuring results, and handling engagement.

API key Customer connects You publish Track every target
48documented operations
11resource families
11social platform guides
01

Authenticate your backend

Create a server-side key in the workspace. Test keys exercise the complete sandbox lifecycle; live keys can publish through connected providers.

Verify your keyPostGate API
curl https://postgate.studio/api/platforms \
  -H "Authorization: Bearer $POSTGATE_API_KEY"

Start with the authentication guide for modes, scopes, group-bound keys, and tenant context.

02

Connect a customer account

Create a profile group for the customer, request a short-lived hosted URL, and redirect their browser to it.

Create hosted connection URLPostGate API
curl -X POST https://postgate.studio/api/profiles/connect \
  -H "Authorization: Bearer $POSTGATE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "platform": "instagram",
    "profile_group_id": "grp_acme123",
    "return_url": "https://app.example.com/settings/social"
  }'
Response
{
  "platform": "instagram",
  "url": "https://postgate.studio/connect/eyJ...",
  "expires_in": 900
}

Open url in the customer's browser. After the provider flow, persist the returned profile_id or list profiles by group.

03

Publish with idempotency

Send connected profile IDs and one stable idempotency key per logical post. The request may target several platforms and finish partially.

Create a postPostGate API
curl -X POST "https://postgate.studio/api/posts?profile_group_id=grp_acme123" \
  -H "Authorization: Bearer $POSTGATE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: launch-post-001" \
  -d '{
    "post": { "body": "Launch day. 🚀" },
    "profiles": ["pro_instagram123", "pro_linkedin456"],
    "media": ["https://cdn.example.com/launch.jpg"]
  }'
Schedule

Add an ISO 8601 scheduled_at.

Queue

Use scheduled_at: "queue" for the next slot.

Draft

Add draft: true for approval.

04

Observe each target

The create response is acceptance. Read each target or subscribe to signed webhooks for publication, partial success, failure, and reconnect requirements.

scheduledprocessingpublished

Use the delivery lifecycle to model target state and the webhook guide to remove polling from your normal path.

Complete resource directory

Everything the API offers, documented by job.

Start with the resource you need, then use the interactive reference for exact schemas and response variants.

For AI agents

Use a smaller, draft-first tool surface.

The hosted MCP server exposes the common publishing and engagement workflow. Post creation remains a draft unless an agent explicitly confirms publication.