Experience Cloud Sites List

Get a list of all Experience Cloud sites available to the context user. Create an Experience Cloud site.

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 sites with the specified status. Valid values are: `Live` `Inactive` `UnderConstruction` Only users with the Manage Experiences permission can see sites with an `Inactive` status.	Optional	28.0

Parameter Name

Type

Description

Required or Optional

Available Version

status

String

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

Live
Inactive
UnderConstruction

Only users with the Manage Experiences permission can see sites with an Inactive status.

Optional

28.0

Response body for GET

Community Page

Request body for POST

JSON example

1{
2   "name":"The Capricorn Cafe",
3   "urlPathPrefix":"capricorncafe",
4   "templateName":"B2B Commerce Template",
5   "templateParams":{"CreateStoreDefaults":"ALL"},
6   "description":"Coffee and coffee products for the most discerning tastes."
7}

Properties

Name	Type	Description	Required or Optional	Available Version
`description`	String	Description of the site.	Optional	46.0
`name`	String	Name of the site.	Required	46.0
`templateName`	String	Name of the Experience Builder template for the site. Use the Experience Builder Templates resource to get a list of available templates and their names.	Required	46.0
`templateParams`	Map<String, String>	Map of template-specific parameters. Valid values are: "`AuthenticationType`" : "`AUTHENTICATED`" "`AuthenticationType`" : "`UNAUTHENTICATED`" (version 52.0–55.0) "`AuthenticationType`" : "`AUTHENTICATED_WITH_PUBLIC_ACCESS`" "`CreateStoreDefaults`" : "`ALL`" "`CreateStoreDefaults`" : "`NONE`" `AuthenticationType` values are valid when creating an Experience Cloud site using the Build Your Own (LWR) template. `CreateStoreDefaults` values are valid when creating an Experience cloud site using the B2B or B2C store template.	Optional	52.0
`urlPathPrefix`	String	URL prefix for the site. For example, in the site URL `MyDomainName`.my.site.com/customers, customers is the UrlPathPrefix.	Required if you already have a site that doesn’t have a `urlPathPrefix`	46.0

Response body for POST

Community Create

Connect REST API Developer Guide

Experience Cloud Sites List