Social API reference

Social API · Moderation-Admin

get/v1/workspaces/{workspace_id}/communities/{community_id}/moderation/blocked-termsAuth

List the community hidden-words lexicon, newest-first. Cursor-paginated (50/page, max 200). Optional `?q=` substring search over the term, 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

Maximum number of items to return (1-200, default 50).

cursorstring

Opaque cursor from the previous page's `pagination.next_cursor`; omit for the first page.

qstring

Case-insensitive substring matched against the blocked term. `%` and `_` are matched literally. Blank means no filter; over 128 chars is a 400.

Response · 200 Page of blocked terms.

data*array

The blocked terms 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/blocked-terms
Authorization: Bearer YOUR_TOKEN

Response

{
  "data": [
    {
      "id": "ffffffff-2222-0000-0000-000000000001",
      "community_id": "cccccccc-cccc-cccc-cccc-cccccccccccc",
      "term": "spoiler",
      "action": "hide",
      "created_at": "2026-05-01T12:00:00.000Z"
    }
  ],
  "pagination": {
    "next_cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNi0wNS0wMVQxMjowMDowMC4wMDBaIiwiaWQiOiJiYmJiIn0",
    "has_more": true
  }
}