Getsocialclaw

SocialClaw API

Complete SocialClaw API reference for social account connections, media uploads, validation, scheduling, publishing, analytics, dashboard APIs, webhooks, and…

Social#social

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Complete SocialClaw API reference for social account connections, media uploads, validation, scheduling, publishing, analytics, dashboard APIs, webhooks, and delivery URLs.

Endpoints 91

Status and Authentication

  • GETService health/healthReturns service, database, storage, worker, billing, and public URL health. Note: Use this route for uptime checks. It does not require a workspace or API…
  • POSTValidate API key/v1/keys/validateChecks the bearer token, returns the workspace, and updates last-used metadata.
  • GETList API keys/v1/keysLists API key metadata for the authenticated workspace. Secrets are not returned from the public key API.
  • POSTCreate API key/v1/keysCreates an additional API key for the authenticated workspace.
  • DELETERevoke API key/v1/keys/:keyIdRevokes an API key. The current key cannot revoke itself through this public route.
  • GETWorkspace usage/v1/me/usageReturns workspace usage counters and entitlement consumption.
  • GETWorkspace health/v1/workspace/healthReturns tenant-specific account, scheduling, and workspace health.
  • GETList jobs/v1/jobsLists worker jobs for the workspace.

Connections and Accounts

  • POSTStart connection/v1/connections/startStarts a provider connection. OAuth providers return an authorize URL; Telegram and Discord create manual connections. Note: Supported providers: x, facebook,…
  • GETList connections/v1/connectionsLists OAuth and manual connection handshakes for the workspace.
  • GETConnections health/v1/connections/healthChecks connected account health and provider readiness.
  • GETConnection status/v1/connections/:connectionIdReturns the status of one connection handshake.
  • GETList connected accounts/v1/accountsLists connected social accounts and destinations in the workspace.
  • GETList account capabilities/v1/accounts/capabilitiesLists publishing capabilities across connected accounts.
  • GETGet account capabilities/v1/accounts/:accountId/capabilitiesReturns publishing capabilities for one connected account.
  • GETGet publish settings/v1/accounts/:accountId/settingsReturns provider-specific settings fields for one account, such as privacy, reply controls, or media modes.
  • GETList discovery actions/v1/accounts/:accountId/actionsLists provider discovery actions available for one connected account.
  • POSTRun discovery action/v1/accounts/:accountId/actions/:actionIdRuns a provider discovery action such as syncing boards, pages, or remote channel metadata.
  • DELETEDisconnect account/v1/accounts/:accountIdDisconnects a social account from the workspace.
  • GETOAuth provider callback/oauth/:provider/callbackCompletes provider OAuth. This route is called by providers after the user authorizes SocialClaw. Note: Human users are redirected back to the dashboard or…

Publishing Runs and Posts

  • GETList posts/v1/postsLists timeline posts in the workspace.
  • GETGet post detail/v1/posts/:postIdReturns one post with provider, attempt, and preview details.
  • DELETECancel post/v1/posts/:postIdCancels a draft or scheduled SocialClaw post before publish.
  • GETList post attempts/v1/posts/:postId/attemptsReturns publish attempts for one post.
  • POSTReconcile post/v1/posts/:postId/reconcileAsks SocialClaw to refresh provider-side post status and metadata.
  • POSTValidate schedule/v1/posts/validateValidates and normalizes a posts[] or campaigns[] schedule without creating a run. Note: Use this before handing a generated schedule to /v1/posts/apply.…
  • POSTPreview campaign/v1/campaigns/previewBuilds a campaign graph from campaigns[] and preflights connected accounts. Note: Requires a campaigns[] schedule. Flat posts[] schedules return a conflict.
  • POSTCreate run/v1/posts/applyCreates a scheduled or draft run from a validated schedule. Note: Use idempotencyKey for generated schedules and retry-safe clients. Note: The route…
  • GETRun status/v1/runs/:runId/statusReturns run status, posts, and summary.
  • GETRun campaign graph/v1/runs/:runId/campaignReturns the campaign graph associated with a run.
  • GETRun detail/v1/runs/:runIdReturns run, posts, attempts, and provider details.
  • POSTPublish draft run/v1/runs/:runId/publishTurns a draft run into scheduled posts, optionally shifting the start time.
  • GETRun table/v1/runs/:runId/tableReturns a compact table projection for a run.
  • POSTRetry post/v1/posts/:postId/retryQueues a failed post for another publishing attempt.
  • POSTDelete provider post/v1/posts/:postId/deleteDeletes a published provider-side post where the provider supports deletion. Note: This does not just cancel the SocialClaw post. It attempts provider-side…

Assets and Media Delivery

  • GETList assets/v1/assetsLists uploaded media in the workspace, newest first. Each asset includes a publicUrl reusable as media_link.
  • POSTRegister asset/v1/assetsRegisters an existing object or externally managed asset in the workspace.
  • POSTUpload asset/v1/assets/uploadUploads a small media file as base64 and returns a SocialClaw delivery URL. Note: Use POST /v1/assets/import for anything large: it takes a URL instead of…
  • POSTImport asset from URL/v1/assets/importDownloads an image or video from a public URL into the media library. Returns 201 with a ready asset when the import finishes within about 40 seconds,…
  • GETGet asset/v1/assets/:assetIdReturns one asset with its status (uploading, ready, or failed) and, for running imports, importProgress.
  • DELETEDelete asset/v1/assets/:assetIdMarks an asset for deletion after the retention window.
  • GETFetch media asset/media/:assetId/:deliveryToken/:filenameStreams a public media asset by delivery URL. Note: HEAD is also supported for metadata checks.
  • GETFetch media preview/media/:assetId/:deliveryToken/previews/:filenameStreams a generated thumbnail, poster, or preview asset. Note: HEAD is also supported for metadata checks.

Analytics

  • GETPost analytics/v1/analytics/posts/:postIdReturns the latest stored metrics snapshot for one published post. Native stats are available for Instagram, TikTok, YouTube, Reddit, X, Pinterest, and…
  • GETAccount analytics/v1/analytics/accounts/:accountIdReturns account-level metrics when provider support is available.
  • GETRun analytics/v1/analytics/runs/:runIdReturns aggregate metrics for a run.
  • POSTRefresh post analytics/v1/analytics/refreshFetches fresh provider analytics for a published post and stores a snapshot. Native stats are supported for Instagram, TikTok, YouTube, Reddit, X, Pinterest,…

Browser Authentication

  • GETAuthentication configuration/v1/auth/configReturns the sign-in providers currently available to the web client.
  • POSTStart email sign-up/v1/auth/email/sign-upCreates a pending credential and sends a single-use verification link. No workspace is created until the address is verified.
  • POSTEmail sign-in/v1/auth/email/sign-inVerifies an email credential and sets the signed dashboard session cookie.
  • POSTVerify email/v1/auth/email/verifyConsumes a verification token, links or creates the SocialClaw user, and sets the dashboard session cookie.
  • POSTRequest password reset/v1/auth/email/forgot-passwordSends an account recovery email and always returns the same response to prevent account discovery.
  • POSTReset password/v1/auth/email/reset-passwordConsumes a reset token, replaces the password hash, and invalidates older dashboard sessions.

Dashboard Browser API

  • GETDashboard session/v1/dashboard/sessionReturns the current signed-in dashboard user, workspace, and membership.
  • POSTCreate support request/v1/support/requestSubmits a support request from the site or dashboard.
  • GETBilling state/v1/billing/stateReturns workspace billing state for the dashboard.
  • POSTCreate checkout/v1/billing/checkoutCreates a billing checkout session for a dashboard billing admin.
  • POSTCreate billing portal/v1/billing/manageCreates a customer billing management URL for a dashboard billing admin.
  • POSTAccept cancellation retention offer/v1/billing/cancel/offerApplies an eligible 30-day free Lemon Squeezy pause while preserving workspace access. PayPal subscriptions continue in the provider portal instead.
  • POSTOpen cancellation portal/v1/billing/cancel/portalRecords optional cancellation feedback and returns the Lemon Squeezy customer portal URL. SocialClaw does not cancel the subscription itself.
  • GETApp Store account token/v1/billing/app-store/account-tokenReturns or creates an App Store account token for the dashboard workspace.
  • GETApp Store products/v1/billing/app-store/productsLists App Store product mappings.
  • POSTClaim App Store transaction/v1/billing/app-store/transactions/claimClaims a signed App Store transaction for the dashboard workspace.
  • GETDashboard accounts/v1/dashboard/accountsLists connected accounts for the dashboard.
  • DELETEDashboard disconnect account/v1/dashboard/accounts/:accountIdDisconnects an account from the dashboard.
  • GETDashboard publish settings/v1/dashboard/accounts/:accountId/publish-settingsReturns provider-specific settings for dashboard compose.
  • POSTDashboard start connection/v1/dashboard/connections/startStarts an OAuth or manual connection from the dashboard.
  • GETDashboard connection status/v1/dashboard/connections/:connectionIdReturns dashboard connection status.
  • GETDashboard posts/v1/dashboard/postsLists dashboard timeline posts.
  • POSTDashboard reconcile post/v1/dashboard/posts/:postId/reconcileRefreshes provider-side status for a dashboard post.
  • DELETEDashboard delete post/v1/dashboard/posts/:postIdDeletes an editable timeline post from the dashboard.
  • PATCHDashboard update post/v1/dashboard/posts/:postIdUpdates an editable dashboard timeline post.
  • GETDashboard assets/v1/dashboard/assetsLists ready assets for the dashboard media picker.
  • DELETEDashboard delete asset/v1/dashboard/assets/:assetIdMarks a dashboard asset for deletion.
  • POSTDashboard base64 asset upload/v1/dashboard/assets/uploadUploads a small dashboard asset as base64.
  • POSTDashboard multipart initiate/v1/dashboard/assets/upload/initiateStarts a multipart asset upload when S3 storage is available.
  • POSTDashboard multipart sign part/v1/dashboard/assets/upload/:assetId/partSigns one multipart upload part for direct browser upload.
  • POSTDashboard multipart complete/v1/dashboard/assets/upload/:assetId/completeCompletes a multipart dashboard upload and marks the asset ready.
  • POSTDashboard multipart abort/v1/dashboard/assets/upload/:assetId/abortAborts a multipart dashboard upload.
  • POSTDashboard compose/v1/dashboard/composeCreates a scheduled run from dashboard compose state and can publish immediately.
  • GETDashboard list keys/v1/dashboard/keysLists dashboard API keys, including secrets for dashboard display.
  • POSTDashboard create key/v1/dashboard/keysCreates a workspace API key from the dashboard.
  • DELETEDashboard revoke key/v1/dashboard/keys/:keyIdRevokes a workspace API key from the dashboard.
  • POSTDashboard rotate key/v1/dashboard/keys/:keyId/rotateRotates a workspace API key and returns the new secret.

Auth, Billing, and Provider Callbacks

  • GETMobile Google auth start/auth/mobile/google/startStarts native/mobile dashboard authentication with Google.
  • GETMobile Apple auth start/auth/mobile/apple/startStarts native/mobile dashboard authentication with Apple.
  • POSTNative Apple token exchange/auth/mobile/apple/nativeExchanges a native Apple identity token for a SocialClaw dashboard session payload.
  • POSTBilling webhook/v1/billing/webhookProcesses Lemon Squeezy billing events. Note: Requests must include the expected billing signature header.
  • POSTApp Store server notification/v1/billing/app-store/notificationsProcesses signed App Store server notifications.
  • POSTMeta deauthorize webhook/webhooks/meta/deauthorizeReceives Meta deauthorization callbacks.
  • POSTMeta data deletion webhook/webhooks/meta/data-deletionReceives Meta data deletion requests and returns a deletion status URL/code.

API details

Base URL
https://getsocialclaw.com
Authentication
A bearer token in the Authorization header
An API key in the socialclaw_dash_session cookie
An API key in the x-signature header
Operations
91 operations on 85 pathsGET 41POST 41DELETE 8PATCH 1
Main resources
Dashboard Browser API 31Publishing Runs and Posts 15Connections and Accounts 12Assets and Media Delivery 8Status and Authentication 8Auth, Billing, and Provider Callbacks 7Browser Authentication 6Analytics 4
Response formats
application/json application/octet-stream
Description format
OpenAPI 3.1.0, API version 1.0.0

How to test the SocialClaw API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the SocialClaw API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Service health” (GET /health), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the SocialClaw API?

Complete SocialClaw API reference for social account connections, media uploads, validation, scheduling, publishing, analytics, dashboard APIs, webhooks, and… It is listed under Social and has 91 endpoints.

Who publishes the SocialClaw API?

It is listed from Getsocialclaw's public API description (an OpenAPI document), not published by Getsocialclaw on Swastik Codes. Anyone who controls getsocialclaw.com can claim the profile by adding a DNS TXT record.

What is the base URL of the SocialClaw API?

Requests go to https://getsocialclaw.com. Endpoint paths are added to this base URL.

How do I authenticate with the SocialClaw API?

It accepts 3 methods: A bearer token in the Authorization header; an API key in the socialclaw_dash_session cookie; an API key in the x-signature header.

How many endpoints does the SocialClaw API have?

91 operations on 85 paths (41 GET, 41 POST, 8 DELETE, 1 PATCH). The largest groups are Dashboard Browser API, Publishing Runs and Posts, Connections and Accounts, Assets and Media Delivery.

Is forking the SocialClaw API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.