Use the Sites API for managing sites, site collections and languages in the XM Apps system.

This API lets you interact with:

  • The Site Collection object. Use a site collection to group together related sites that share the same resources.
  • The Site object. The site object is the core entity that represents a website in the customer portfolio.
  • The Language object. The language object is used to manage the languages available to a tenant and site.
  • The Job object. The job object is used to manage running background jobs.

Note the following:

  • All API requests are made in your production environment.

For more information, see the official SitecoreAI developer documentation.

Request

Fetches the list of sites in the environment, with associated details.

Security
Bearer
Query
environmentIdstring

The identifier of the environment

Example:environmentId=main
curl -i -X GET \
  'https://xmapps-api.sitecorecloud.io/api/v1/sites?environmentId=main' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
Array [
idstring or null

The identifier of the site. Example value: 497f6eca-6276-4993-bfeb-53cbbbba6f08

Example:"497f6eca-6276-4993-bfeb-53cbbbba6f08"
namestring or null

The name of the site. Example value: skate-park

Example:"skate-park"
descriptionstring or null

The description of the site. Example value: New site for Brand A in English-speaking countries

Example:"New site for Brand A in English-speaking countries"
displayNamestring or null

The display name of the site. Example value: Skate Park Website

Example:"Skate Park Website"
thumbnailobject(Thumbnail)

The thumbnail response entity.

collectionIdstring or null

The identifier of the collection to which the site belongs. Example value: 5aae1eeaea2440bf96f11f43da82c77b

Example:"5aae1eeaea2440bf96f11f43da82c77b"
createdstring, (date-time)

The date when the site was created. Example value: 2019-08-24T14:15:22Z

Example:"2019-08-24T14:15:22Z"
createdBystring or null

The ID of the user who created the site. Example value: L6kfw52ZVf

Example:"L6kfw52ZVf"
sortOrderinteger or null, (int32)

Sort order of the site. Example value: 100

Example:100
brandKitIdstring or null

The identifier of the brand kit associated with this site. Example value: e3f1c5a2-4b6d-4a3e-9f1b-2d3c4b5a6e7f

Example:"e3f1c5a2-4b6d-4a3e-9f1b-2d3c4b5a6e7f"
permissionsobject(Permissions)

The access rights of the current user to the site.

languagesArray of strings or null

The list of languages in use by the site. Example value: [ "en-US", "en-CA" ]

Example:
[ "en-US", "en-CA" ]
hostsArray of objects or null(Host)

The list of hosts that the site resolves to.

supportedLanguagesArray of strings or null

The list of languages supported by Sitecore. Example value: [ "en-US", "en-CA" ]

Example:
[ "en-US", "en-CA" ]
errorPagesobject(ErrorPages)

An object containing the site error pages identifiers

errorPagesConfigurationobject(ErrorPagesConfiguration)

An object containing the site error pages

settingsobject or null

The settings for the site.

Example:
{ "thumbnailsRootPath": "/sitecore/media library/Project/sample-collection/sample-site", "generateThumbnails": "true" }
propertiesobject or null

The read-only properties of the site.

Example:
{ "SxaSiteTemplate": "{E46F3AF2-39FA-4866-A157-7017C4B2A40C}", "IsSxaSite": "true" }
]
Response
[ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "skate-park", "description": "New site for Brand A in English-speaking countries", "displayName": "Skate Park Website", "thumbnail": { … }, "collectionId": "5aae1eeaea2440bf96f11f43da82c77b", "created": "2019-08-24T14:15:22Z", "createdBy": "L6kfw52ZVf", "sortOrder": 100, "brandKitId": "e3f1c5a2-4b6d-4a3e-9f1b-2d3c4b5a6e7f", "permissions": { … }, "languages": [ … ], "hosts": [ … ], "supportedLanguages": [ … ], "errorPages": { … }, "errorPagesConfiguration": { … }, "settings": { … }, "properties": { … } } ]