Request

Fetches the list of site collections in the environment, with associated details.

Security
Bearer
Query
environmentIdstring
curl -i -X GET \
  'https://xmapps-api.sitecorecloud.io/api/v1/collections?environmentId=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
Array [
idstring or null

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

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

The unique system name of the site collection. Example value: skate-park-sites

Example:"skate-park-sites"
descriptionstring or null

The description of the site collection. Example value: Collection for all Skate Park brand websites.

Example:"Collection for all Skate Park brand websites."
displayNamestring or null

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

Example:"Skate Park Websites"
sortOrderinteger or null, (int32)

Sort order of the site collection. Example value: 100

Example:100
createdBystring or null

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

Example:"L6kfw52ZVf"
createdstring, (date-time)

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

Example:"2019-08-24T14:15:22Z"
permissionsobject(Permissions)

The access rights of the current user to the site.

settingsobject or null

The site collection settings.

Example:
{ "itemPath": "/sitecore/content/skate-park-sites" }
]
Response
[ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "skate-park-sites", "description": "Collection for all Skate Park brand websites.", "displayName": "Skate Park Websites", "sortOrder": 100, "createdBy": "L6kfw52ZVf", "created": "2019-08-24T14:15:22Z", "permissions": { … }, "settings": { … } } ]