API reference

Endpoints

Route catalog for posts, links, bio, campaigns, media, analytics, and webhooks.

Route catalog for the supported integrator API. Start with the introduction for base URL, authentication, and response codes.

Plan requirement: API access requires Team or Agency. See pricing.

Posts

Schedule, publish, and manage social content.

Method	Path	Scope
GET	`/v1/posts`	`posts:read`
POST	`/v1/posts`	`posts:write`
GET	`/v1/posts/calendar`	`posts:read`
GET	`/v1/posts/:id`	`posts:read`
PATCH	`/v1/posts/:id`	`posts:write`
DELETE	`/v1/posts/:id`	`posts:delete`
POST	`/v1/posts/:id/reschedule`	`posts:write`
POST	`/v1/posts/:id/cancel`	`posts:write`
POST	`/v1/posts/:id/duplicate`	`posts:write`
POST	`/v1/posts/:id/delete-from-networks`	`posts:delete`
GET	`/v1/posts/:id/live-preview`	`posts:read`
POST	`/v1/posts/:id/approval/:action`	`approval_tasks:*`

Pass companyId for company workspaces. Use mediaFileIds from the media library for attachments. List connected accounts with GET /v1/social/accounts before setting targets[].socialAccountId.

Links

Short links with folders, tags, geo/device routing, A/B tests, custom OG, and branded QR.

Method	Path	Scope
GET	`/v1/links`	`links:read`
POST	`/v1/links`	`links:write`
GET	`/v1/links/:id`	`links:read`
PATCH	`/v1/links/:id`	`links:write`
DELETE	`/v1/links/:id`	`links:write`
POST	`/v1/links/bulk`	`links:write`
PATCH	`/v1/links/bulk`	`links:write`
DELETE	`/v1/links/bulk`	`links:write`
GET	`/v1/links/:id/qr`	`links:read`
GET/PATCH	`/v1/links/groups`, `/v1/links/tags`	`links:read` / `links:write`
CRUD	`/v1/links/:id/routing-rules/*`	`links:read` / `links:write`
CRUD	`/v1/links/:id/experiment/*`	`links:read` / `links:write`

Bio pages

Bio builder pages share link scopes (links:read, links:write).

Method	Path	Scope
GET	`/v1/bio`	`links:read`
POST	`/v1/bio`	`links:write`
GET/PATCH/DELETE	`/v1/bio/:id`	`links:read` / `links:write`
CRUD	`/v1/bio/:id/versions/*`	`links:read` / `links:write`
GET	`/v1/bio/:id/preview`	`links:read`
GET	`/v1/analytics/bio/:id`	`analytics:read`

Campaigns

Method	Path	Scope
GET	`/v1/campaigns`	`campaigns:read`
POST	`/v1/campaigns`	`campaigns:write`
GET/PATCH/DELETE	`/v1/campaigns/:id`	`campaigns:read` / `campaigns:write` / `campaigns:delete`

Media

Upload before attaching files to posts.

Method	Path	Scope
POST	`/v1/media/upload`	`media:write`
POST	`/v1/media/upload/presign`	`media:write`
POST	`/v1/media/upload/complete`	`media:write`
POST	`/v1/media/upload-from-url`	`media:write`
GET	`/v1/media/library`	`media:write`
GET	`/v1/media/library/:id/view`	`media:write`

List responses include short-lived viewUrl values. Refresh with GET …/view when URLs expire.

Method	Path	Scope
GET	`/v1/social/accounts`	`social:read`

Analytics

Method	Path	Scope
GET	`/v1/analytics/social/*`	`analytics:read`
GET	`/v1/analytics/links/*`	`analytics:read`
GET	`/v1/analytics/bio/*`	`analytics:read`

Webhooks

Manage outbound event subscriptions. See Webhooks for payloads and signatures.

Method	Path	Scope
GET	`/v1/webhooks/event-types`	`webhooks:read`
GET/POST	`/v1/webhooks/endpoints`	`webhooks:read` / `webhooks:write`
GET/PATCH/DELETE	`/v1/webhooks/endpoints/:id`	`webhooks:read` / `webhooks:write`
GET	`/v1/webhooks/deliveries`	`webhooks:read`

Community

Method	Path	Scope
GET	`/v1/community/comments`	`posts:read`
CRUD	`/v1/community/platform-comments/:id/*`	`posts:read` / `posts:write`
GET	`/v1/community/analytics`	`analytics:read`

Automations and approvals

Requires Automations on the workspace plan.

Area	Paths	Scopes
Automations	`/v1/automations/*`	`automations:read`, `automations:write`, `automations:delete`
Approval flows	`/v1/approval-flows/*`	`approval_flows:*`
Post approval	`/v1/posts/:id/approval/:action`	`approval_tasks:act`, `approval_tasks:reassign`, `approval_override`

Examples

Create a scheduled post

RequestPOST

Authorization: Bearer sty_live_your_api_key
Content-Type: application/json

{
  "companyId": "clxyz_company",
  "content": "Summer launch. Book now.",
  "status": "SCHEDULED",
  "scheduledAt": "2026-08-01T14:00:00.000Z",
  "mediaFileIds": ["clmf_media_abc123"],
  "targets": [
    {
      "socialAccountId": "clsa_instagram_1"
    }
  ]
}

Response201 Created

{
  "id": "clpost_abc",
  "status": "SCHEDULED",
  "scheduledAt": "2026-08-01T14:00:00.000Z"
}

Create a short link