Site

List sites with pagination

Returns a paginated list of sites that the currently logged-in user has access to. Supports filtering by name, archived status, live status, and system site inclusion.

get/api/v1/site

Query parameters

filterstring

Filter string for site names. Use '*' suffix for wildcard matching, or 'all' to return all sites

archiveboolean

Include archived sites in the results

liveboolean

Filter to show only live sites

systemboolean

Include the system site in the results

pageinteger

Page number for pagination (zero-based)

per_pageinteger

Number of results per page

Response

Paginated list of sites retrieved successfully

entityobject[]
i18nMessagesMapobject
permissionsstring[]

Changes

No recorded changes to this endpoint across all 1 revision of this API.