Communities List

Get a list of all communities available to the context user. Create a community.

Resource

1/connect/communities/

Available version

28.0

Requires Chatter

HTTP methods

GET, POST

POST is available in version 46.0 and later.

Request parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
`status`	String	Returns only communities with the specified status. Valid values are: `Live` `Inactive` `UnderConstruction` Only users with the Manage Network permission enabled can see communities with an `Inactive` status.	Optional	28.0

Parameter Name

Type

Description

Required or Optional

Available Version

status

String

Returns only communities with the specified status. Valid values are:

Live
Inactive
UnderConstruction

Only users with the Manage Network permission enabled can see communities with an Inactive status.

Optional

28.0

Response body for GET

Community Page

Request body for POST

Root XML tag

<community>

JSON example

1{
2   "name":"The Capricorn Cafe",
3   "urlPathPrefix":"capricorncafe",
4   "templateName":"Customer Service",
5   "description":"Coffee and coffee products for the most discerning tastes."
6}

Properties

Name	Type	Description	Required or Optional	Available Version
`description`	String	Description of the community.	Optional	46.0
`name`	String	Name of the community.	Required	46.0
`templateName`	String	Name of the template for the community. Use the Communities Templates resource to get a list of available templates and their names.	Required	46.0
`urlPathPrefix`	String	URL prefix for the community.	Required if you already have a community that doesn’t have a `urlPathPrefix`	46.0

Response body for POST

Community Create

Chatter REST API Developer Guide

Communities List