ANanzworldline-solutions
Site

List sites with pagination

Changed on

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

Request

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

  • 4fd8e917d458Revision changes
    • info

      api operation id sites removed and replaced with getSites

    • info

      api tag Site added

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status