Retrieving site codes
GET {{baseUrl}}/site/{{tenant}}/siteslist?includeInactive=false&pageNumber=1&pageSize=16&sort=sin&totalCount=false
Retrieves a list of site codes.
Required scopes
site.site_readsite.site_manage
Note: The site.site_manage scope is only required if you want to retrieve inactive sites.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
includeInactive | boolean | ||
| --- | --- | ||
true | Retrieves both the active and inactive sites. | ||
false | Retrieves only the active sites. | ||
pageNumber | number | Page number to be retrieved. The number of the first page is 1. |
Note: If the pageNumber parameter is passed, size of the pages must be specified in the pageSize parameter.
|
| pageSize | number | | Number of products to be retrieved per page.
|
| sort | string | | List of properties used to sort the results, separated by commas.
Possible values:
{fieldName}{fieldName}.asc{fieldName}.desc
Note: If you want to sort the results by localized properties, the possible values are:
{fieldName}.{language}{fieldName}.{language}.asc{fieldName}.{language}.desc
By default, the fields are sorted in ascending order.
|
| totalCount | boolean | | If set to true, a total number of sites is returned in a response header. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
["main","example"]