SyncPostly API overview
Base concepts, versioning, and what the SyncPostly API covers
Quick picks
Jump into the guides customers hit most often.
Getting startedSet up your workspace, connect accounts, and publish the first post.Social media connectionsOAuth requirements, scopes, and per-platform connection steps.Scheduling and publishingHow queues, retries, and multi-account scheduling work.Media limitsFile types, durations, and how we transcode uploads.Account and billingPlan changes, credits, refunds, and lifetime access.TroubleshootingCommon errors across Meta, TikTok, YouTube, and magic links.API accessEnable the automation add-on and issue API keys.External integrationsWebhooks, embeds, and sending data to other tools.FAQShort answers to the most common workspace questions.
The developer API in SyncPostly is organized around Media, Posts, Social Accounts, and Post Results. Use it to programmatically create posts, attach media, query account inventory, and pull publish results.
Base server and versioning
- Base URL:
https://<your-app-host>/api/v1(in local dev this ishttp://localhost:3000/api/v1). - Version:
v1. - Transport: JSON over HTTPS. UTF-8 everywhere.
Typical integration flow
- Create or rotate an API key.
- Upload media or register remote media URLs.
- Create a post with one or more target social accounts.
- Poll the post or post-results endpoints to watch delivery status.
- Persist external IDs on your side for idempotency and reporting.
What this section covers
- Authentication and API key lifecycle.
- Standard error and pagination contract used by all list endpoints.
- Resource-specific pages for Media, Posts, Social Accounts, Post Results, and shared models.
Client snippets
The reference is written for curl, but the payloads map directly to any HTTP
client (Fetch, Axios, Python requests, Ruby Net::HTTP, etc.). Replace
YOUR_SECRET_TOKEN with a live key and keep it server-side.