On this page

7 endpoints.

MethodPathSummary
GET/api/communitiesGet all communities
POST/api/communitiesCreate a new community (Super Admin only)
DELETE/api/communities/{id}Delete community (Super Admin only)
GET/api/communities/{id}Get a single community by ID
PUT/api/communities/{id}Update community (Community Admin or Super Admin)
PATCH/api/communities/{id}/archiveArchive (hide) a community - Community Admin only
PATCH/api/communities/{id}/unarchiveUnarchive (restore) a community - Community Admin only

Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
pagequerynointeger—
limitquerynointeger—
searchquerynostring—

Responses

StatusDescriptionBody
200Communities list with pagination—

Auth: Bearer JWT required.

Request body (required) — application/json

FieldTypeRequiredDescription
namestringyes—
nameArabicstringyes—
slugstringyes—
descriptionstringno—
descriptionArabicstringno—
logostringno—
typeenum: PUBLIC, PRIVATEnoCommunity visibility (preferred — single source of truth).
isPublicbooleannoDeprecated — pass type instead. Still accepted as input for back-compat; the underlying column was removed in the Community.isPublic removal plan, commit 4.

Responses

StatusDescriptionBody
201Community created successfully—
403Only Super Admins can create communities—

Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
idpathyesstring—

Responses

StatusDescriptionBody
200Community deleted—
403Only Super Admins can delete communities—

Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
idpathyesstring—

Responses

StatusDescriptionBody
200Community details—
404Community not found—

Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
idpathyesstring—

Responses

StatusDescriptionBody
200Community updated—

Changes community status to ARCHIVED, hiding it from listings while preserving all data Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
idpathyesstringCommunity ID

Responses

StatusDescriptionBody
200Community archived successfully—
401Authentication required—
403Only Community Admins can archive their community—
404Community not found—

Changes community status from ARCHIVED back to ACTIVE, making it visible again Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
idpathyesstringCommunity ID

Responses

StatusDescriptionBody
200Community restored successfully—
401Authentication required—
403Only Community Admins can restore their community—
404Community not found—