POST

Query Sites


Retrieves a list of up to 1,000 sites, given the provided paging, sorting and filtering.

Important: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Read Site Data
SCOPE.ACCOUNT.BASIC_TEAM_MEMBER
SCOPE.CUSTOMER-CARE.MANAGE-TICKETS
Enterprise Account Content Administrator
Enterprise Account Content Editor
Wix CLI - Full Permissions
SCOPE.WIX_CLI.MANAGE_APPS
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/site-list/v2/sites/query

Body Params
queryQuery

Filter and sorting with the following format: "filter" : { "displayName": "my-site" }

Response Object
sitesArray <Site>

List of retrieved sites.


cursorPagingCursorPagingdeprecated

Paging information.


metadataMetadata

Meta data about the returned sites

Query sites
Request
cURL
Response
JSON
Errors
401Unauthenticated

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?