Social Admin API.
The workspace lane: community CRUD, settings, moderation and analytics. Every endpoint generated from the live OpenAPI spec.
Workspace-scoped operations: community CRUD, community settings (see the settings reference), the moderation queue + flag actions + audit log, the read-only conversation moderation lane, and per-community analytics. These are the endpoints the console itself is built on. Auth: API key bearer, PlatformUser bearer, or session cookie (see the customer lane); each route names the social.* permission it requires.
Base URL
https://api.social.productcraft.coAuth
Authorization: Bearer …Spec version
OpenAPI spec
https://api.social.productcraft.co/docs-jsonAnalytics
Workspace analytics across communities: totals and a daily activity series.
Communities
Communities in a workspace: create, read, update, delete, and the per-community settings.
- get
/v1/workspaces/{workspace_id}/communitiesList communities in a workspace, newest-first. - post
/v1/workspaces/{workspace_id}/communitiesCreate an social community. - get
/v1/workspaces/{workspace_id}/communities/{community_id}Get one community by id. - patch
/v1/workspaces/{workspace_id}/communities/{community_id}Update community display name, description, settings, or status. - delete
/v1/workspaces/{workspace_id}/communities/{community_id}Delete a community.
Conversations-Admin
Workspace-admin view of direct-message conversations, for moderation.
- get
/v1/workspaces/{workspace_id}/communities/{community_id}/moderation/conversationsList every conversation in the community, most-recent-activity first. - get
/v1/workspaces/{workspace_id}/communities/{community_id}/moderation/conversations/{conversation_id}/messagesList every message in a conversation.
Export
Data export: everything a member created, as one JSON document (data portability).
- get
/v1/workspaces/{workspace_id}/communities/{community_id}/actors/{actor_id}/commentsEvery comment an actor authored, all statuses (published / hidden / removed) — the GDPR-export view. - get
/v1/workspaces/{workspace_id}/communities/{community_id}/actors/{actor_id}/reactionsEvery reaction an actor has given — post reactions and comment reactions unified into one stream, discriminated by…
Moderation-Admin
The moderator's lane: the report queue, actions on content and members (remove, mute, suspend, ban), shadow bans and the audit log.
- get
/v1/workspaces/{workspace_id}/communities/{community_id}/moderation/flagsList flags in this community. - post
/v1/workspaces/{workspace_id}/communities/{community_id}/moderation/flags/{flag_id}/actionsApply a moderation action to a flag. - post
/v1/workspaces/{workspace_id}/communities/{community_id}/moderation/actionsApply a moderation action directly, without a preceding flag (task 017). - get
/v1/workspaces/{workspace_id}/communities/{community_id}/moderation/auditAppend-only audit of moderator actions in this community. - post
/v1/workspaces/{workspace_id}/communities/{community_id}/moderation/actors/{actor_id}/shadow-banApply a shadow ban to an actor. - delete
/v1/workspaces/{workspace_id}/communities/{community_id}/moderation/actors/{actor_id}/shadow-banRemove a shadow ban. - get
/v1/workspaces/{workspace_id}/communities/{community_id}/moderation/shadow-bannedList currently shadow-banned actors in this community. - get
/v1/workspaces/{workspace_id}/communities/{community_id}/moderation/blocked-termsList the community hidden-words lexicon, newest-first. - post
/v1/workspaces/{workspace_id}/communities/{community_id}/moderation/blocked-termsAdd a hidden word to the community lexicon. - delete
/v1/workspaces/{workspace_id}/communities/{community_id}/moderation/blocked-terms/{term}Remove a hidden word.
Stats
Social totals and a daily series for the workspace dashboard.
Webhooks
Webhook endpoints that receive post, comment, follow, moderation, message and media events, their delivery log and replays, at the workspace or for one community. The legacy per-community webhook routes are deprecated.
- get
/v1/workspaces/{workspace_id}/communities/{community_id}/webhooks/event-typesList the events an endpoint can subscribe to. - get
/v1/workspaces/{workspace_id}/communities/{community_id}/webhooks/endpointsList webhook endpoints, oldest first. - post
/v1/workspaces/{workspace_id}/communities/{community_id}/webhooks/endpointsAdd a webhook endpoint. - get
/v1/workspaces/{workspace_id}/communities/{community_id}/webhooks/endpoints/{endpoint_id}Get one webhook endpoint (without its secret). - patch
/v1/workspaces/{workspace_id}/communities/{community_id}/webhooks/endpoints/{endpoint_id}Change a webhook endpoint: URL, description, events, on/off. - delete
/v1/workspaces/{workspace_id}/communities/{community_id}/webhooks/endpoints/{endpoint_id}Delete a webhook endpoint. - post
/v1/workspaces/{workspace_id}/communities/{community_id}/webhooks/endpoints/{endpoint_id}/rotate-secretRotate the signing secret. - post
/v1/workspaces/{workspace_id}/communities/{community_id}/webhooks/endpoints/{endpoint_id}/testSend a test event to this endpoint now and return the result. - get
/v1/workspaces/{workspace_id}/communities/{community_id}/webhooks/eventsList webhook events, newest first (kept for 30 days). - get
/v1/workspaces/{workspace_id}/communities/{community_id}/webhooks/events/{event_id}Get one webhook event with every delivery attempt. - post
/v1/workspaces/{workspace_id}/communities/{community_id}/webhooks/events/{event_id}/replaySend a logged event again, to its endpoints or to one endpoint. - get
/v1/workspaces/{workspace_id}/webhooks/event-typesList the events an endpoint can subscribe to. - get
/v1/workspaces/{workspace_id}/webhooks/endpointsList webhook endpoints, oldest first. - post
/v1/workspaces/{workspace_id}/webhooks/endpointsAdd a webhook endpoint. - get
/v1/workspaces/{workspace_id}/webhooks/endpoints/{endpoint_id}Get one webhook endpoint (without its secret). - patch
/v1/workspaces/{workspace_id}/webhooks/endpoints/{endpoint_id}Change a webhook endpoint: URL, description, events, on/off. - delete
/v1/workspaces/{workspace_id}/webhooks/endpoints/{endpoint_id}Delete a webhook endpoint. - post
/v1/workspaces/{workspace_id}/webhooks/endpoints/{endpoint_id}/rotate-secretRotate the signing secret. - post
/v1/workspaces/{workspace_id}/webhooks/endpoints/{endpoint_id}/testSend a test event to this endpoint now and return the result. - get
/v1/workspaces/{workspace_id}/webhooks/eventsList webhook events, newest first (kept for 30 days). - get
/v1/workspaces/{workspace_id}/webhooks/events/{event_id}Get one webhook event with every delivery attempt. - post
/v1/workspaces/{workspace_id}/webhooks/events/{event_id}/replaySend a logged event again, to its endpoints or to one endpoint.