Social API reference

Social API · Moderation-Admin

get/v1/workspaces/{workspace_id}/communities/{community_id}/moderation/shadow-bannedAuth

List currently shadow-banned actors in this community. 50/page (max 200), cursor-paginated newest-ban first. Optional `?q=` substring search over display name OR external id, composable with the cursor.

Path parameters

workspace_id*string · uuid

Id of the workspace.

community_id*string · uuid

Id of the community.

Query parameters

limitinteger

Page size (default 50, max 200).

cursorstring

Opaque cursor from a prior page's `pagination.next_cursor`.

qstring

Case-insensitive substring matched against the actor display name OR external id. `%` and `_` are matched literally. Blank means no filter; over 128 chars is a 400.

Response · 200 Page of shadow-banned actors.

data*array

The actors on this page.

pagination*object
next_cursor*string

Opaque base64url cursor for the next page; `null` when no further pages.

Example: "eyJjcmVhdGVkX2F0IjoiMjAyNi0wNS0wMVQxMjowMDowMC4wMDBaIiwiaWQiOiJiYmJiIn0"

has_more*boolean

`true` when at least one more page exists. Mirrors `next_cursor !== null`; published as a separate field so SDKs can drive a `while` loop without parsing the cursor. A short or empty `data` array does NOT imply the end of the list when a lane post-filters — always page until this is `false`.

Example: true

Example

Request

GET https://social.productcraft.co/v1/workspaces/{workspace_id}/communities/{community_id}/moderation/shadow-banned
Authorization: Bearer YOUR_TOKEN

Response

{
  "data": [
    {
      "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
      "community_id": "cccccccc-cccc-cccc-cccc-cccccccccccc",
      "external_id": "user_abc123",
      "display_name": "Ada Lovelace",
      "avatar_url": "https://cdn.example.com/avatars/ada.png",
      "metadata": {
        "tier": "pro"
      },
      "status": "active",
      "is_private": false,
      "created_at": "2026-05-01T12:00:00.000Z",
      "updated_at": "2026-05-01T12:00:00.000Z",
      "shadow_banned_at": "2026-01-01T00:00:00.000Z",
      "shadow_banned_until": "string",
      "shadow_banned_reason": "string"
    }
  ],
  "pagination": {
    "next_cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNi0wNS0wMVQxMjowMDowMC4wMDBaIiwiaWQiOiJiYmJiIn0",
    "has_more": true
  }
}