List communities
Retrieve a paginated list of communities you have access to.
Query parameters:
| Parameter | Type | Description |
|---|
page | int | Page number (default: 1). |
per_page | int | Items per page (max 50). |
search | string | Filter communities by name. |
{
"data": [
{
"id": "uuid",
"name": "My Community",
"handle": "my-community",
"description": "...",
"member_count": 150,
"is_public": true,
"created_at": "2025-01-01T00:00:00Z"
}
]
}
Retrieve the details of a single community by its ID.
Response: Returns the full community object including settings and metadata.
Create a new community. You become the owner automatically.
Request body:
{
"name": "New Community",
"handle": "new-community",
"description": "A description of the community",
"is_public": true,
"category": "education"
}
| Field | Type | Required | Description |
|---|
name | string | Yes | Display name of the community. |
handle | string | Yes | URL-friendly slug (must be unique). |
description | string | No | Short description shown on the community profile. |
is_public | boolean | No | Whether the community is publicly discoverable. |
category | string | No | Category identifier (e.g. education, fitness). |
Update one or more fields on an existing community. Only the fields you include in the request body are changed.
PATCH /v1/communities/:id
Permanently delete a community and all of its associated data.
DELETE /v1/communities/:id
This action is irreversible. All community data — members, posts, courses, challenges, and events — will be permanently removed.
