List sites

This operation returns a list of all configured sites.

Query Params
string

The filter parameter may be used to filter the returned collection.

string
Defaults to summary

The view parameter may be used to request that either the summary or detailed view be returned.

string

The sortBy parameter may be used to specify the sort order of the returned collection.

integer
≥ 1
Defaults to 1

The pageNumber parameter may be used to specify an offset into the results. Useful to use in conjunction with pageSize. Page number offset is 1-based.

integer
1 to 1000
Defaults to 100

The pageSize parameter may be used to specify the page size of the returned results. Useful to use in conjunction with pageNumber.

Responses

Response body
object
array of objects
required
sites*
object
integer
required
≥ 1

The unique identifier for a site.

string
required
length between 1 and 254

The unique name for this site.

object
required

Common page properties for search results.

integer
required

Indicates the page number of the current results, given the page size.

integer
required

Indicates the page size for the current results.

integer

Indicates the total number of pages, taking the pages size into consideration.

integer

Indicates the total number of results from the search.

Language
Credentials
OAuth2
URL