Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB
Community

List Communities

List communities for a workspace

get/workspaces/{workspace_id}/communities

Path parameters

workspace_idinteger required

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at'

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Response

OK

idinteger

Community ID

public_idstring nullable

Community public ID

site_idinteger

Site ID the community belongs to

workspace_idinteger

Workspace ID the community belongs to

namestring nullable

Community Name

statusstring nullable

Status of the community (e.g. live, draft)

privateboolean

Make this Community Private? When true the community is not accessible to visitors; only invited contacts or buyers can view it.

current_pathstring nullable

Current Path

logo_image_idinteger nullable

Logo Image ID

social_image_idinteger nullable

Social Image ID

seo_titlestring nullable

Seo Title

seo_descriptionstring nullable

Seo Description

seo_indexableboolean

Whether the community is indexed by search engines

white_labelboolean

Enable White Label — when enabled members cannot switch between CF communities or participate in the global feed

allow_public_signupboolean

Allow Public Sign-Up? When enabled guests can sign up and join the community when they try to interact.

upgrade_urlstring nullable

Upgrade URL — sends guests to a page to take action (e.g. Order Page, Funnel). Leave blank to allow free sign-up.

send_membership_emailboolean nullable

Send Membership Email? When enabled an email is sent to the contact when they become a member of the community.

send_digest_emailboolean

Send Digest Email? When enabled contacts who have opted in receive a daily email of unread community notifications.

require_post_approvalsboolean nullable

Require Post Approvals? When enabled all posts require approval before being visible to members.

require_comment_approvalsboolean nullable

Require Comment Approvals? When enabled all comments require approval before being visible to members.

anyone_can_inviteboolean

Anyone Can Invite? When enabled other members can invite new members to join.

invite_onlyboolean

Invite Only? Even public communities can disable signups so visitors can view but not sign up without an invitation.

enable_block_listboolean

Enable Block List? When enabled blocks any posts or comments with common profane words.

notificationsstring nullable

Notification settings (e.g. all, essential, off)

created_atstring date-time nullable

Created at

updated_atstring date-time nullable

Updated at

Example response

[
  {
    "id": 1,
    "public_id": "AbCdEf",
    "site_id": 10,
    "workspace_id": 42,
    "name": "My Community",
    "status": "live",
    "private": false,
    "current_path": "/my-community",
    "logo_image_id": 5,
    "social_image_id": 6,
    "seo_title": "My Community",
    "seo_description": "A great place to connect and learn.",
    "seo_indexable": true,
    "white_label": false,
    "allow_public_signup": false,
    "upgrade_url": null,
    "send_membership_email": true,
    "send_digest_email": false,
    "require_post_approvals": false,
    "require_comment_approvals": false,
    "anyone_can_invite": false,
    "invite_only": false,
    "enable_block_list": false,
    "notifications": "essential",
    "created_at": "2025-01-01T00:00:00.000Z",
    "updated_at": "2025-01-01T00:00:00.000Z"
  }
]