Social API reference

Social API · Communities

get/v1/workspaces/{workspace_id}/communitiesAuth

List communities in a workspace, newest-first. Cursor-paginated as of task 008 / G13 (previously a bare array). Optional `?q=` substring search (display name OR slug) and `?status=` filter, both composable with each other and with the cursor — the ordering is fixed, so keep the same filters on every follow-up page.

Path parameters

workspace_id*string

ProductCraft workspace UUID owning 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 community display name OR slug. `%` and `_` are matched literally. Blank means no filter; over 128 chars is a 400.

statusenum (3)

Exact community status filter. Blank means no filter; an unknown value is a 400.

Response · 200 Paginated communities.

data*array

The communities 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
Authorization: Bearer YOUR_TOKEN

Response

{
  "data": [
    {
      "id": "cccccccc-cccc-cccc-cccc-cccccccccccc",
      "workspace_id": "11111111-1111-1111-1111-111111111111",
      "app_id": "33333333-3333-3333-3333-333333333333",
      "slug": "my-product-community",
      "display_name": "My Product Community",
      "description": null,
      "settings": {
        "max_comment_depth": 3
      },
      "status": "active",
      "created_by": "aaaaaaaa-0000-0000-0000-000000000001",
      "created_at": "2026-05-01T12:00:00.000Z",
      "updated_at": "2026-05-01T12:00:00.000Z"
    }
  ],
  "pagination": {
    "next_cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNi0wNS0wMVQxMjowMDowMC4wMDBaIiwiaWQiOiJiYmJiIn0",
    "has_more": true
  }
}