Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

# About the Sites API

The Sites API is a service that holds public information about Wix sites that is accessible to the site's owner, including the site's name, its URL, its publish status, its owner, display thumbnail, when it was created, if the site has a premium plan attached to it, and more.
Site owners can view their sites via the `My Sites` page, at https://manage.wix.com/account/sites.

Third party resellers, agencies and others can use the Site API to sync their external platform with Wix to allow customers to view and access their Wix sites.
Sites can be filtered by their folder ID, premium status, installed applications, domain connection status and more.

> **Important**: This API is accessible via API keys, which are currently available to selected beta users only. You will not be able to access this API with a standard Auth header.


## Terminology
* **Site**:  A website in the account. Sites are accessible to users according to the specific permissions they hold on a specific site or on the entire account.
* **Folder**: A grouping of sites that account users can create to organize their sites. Each site can only belong to one folder.
* **Account**: A Wix account can have one or more users. Standard accounts have one user while team accounts can have multiple users.
* **Trashed**: A Wix site can be "moved to trash", but not deleted. 


## User Flow
To show all the sites that belong to a specific client:

1. Get a list of sites by querying by site IDs.
2. Optional: you can sort by most recently updated.
3. For each site:  
   a. Show the site’s `displayName`.  
   b. Display the site’s snapshot using `thumbnail`.  
   c. Display the site’s URL using `viewURL`.  
   d. Enable navigation to the Editor by linking the `editUrl`.  
   e. Enable navigation to the site’s dashboard by concatenating "https://manage.wix.com/dashboard/" and the `id` field. Example: https://manage.wix.com/dashboard/412f6f5e-6c38-46df-aee1-66802a2001d1


## Limitations
* The maximum number of sites that can be retrieved by `QuerySites` is 1,000.  
* The Count Sites endpoint does not support `premium` and `appIds` filters.


## Filter

Both the Query Sites and Count Sites endpoints accept the following filters:
* id
  ```
  { id: { $in: ['015c25c0-24e8-4966-a951-a3b458da7351', '04067d48-5b6c-48b5-9c08-8397d7e8d53a'] } }
  ```
* folderId
    * filter sites that are in root level (no folder):
      ```
      { folderId: { $exists: false } }
      ```
    * filter sites that are in a specific folder:
      ```
      { folderId: '54915d80-62c2-4791-8483-88541ed18a60' }
      ```
* editorType
  ```
  { editorType: 'EDITOR' }
  ```
* appIds
    * filter sites that have provided app ids:
      ```
      { appIds: { $hasAll: ['1dbbce47-77b4-4ccf-be8c-8434eab7f58d', '87beaf91-cf01-4209-93ed-eb7cc47dc2cf' ] } }
      ```
    * filter sites that have at least one of the provided app ids:
      ```
      { appIds: { $hasSome: ['1dbbce47-77b4-4ccf-be8c-8434eab7f58d', '87beaf91-cf01-4209-93ed-eb7cc47dc2cf' ] } }
      ```
* premium
    ```
    { premium: true }
    ```
* published
  ```
  { published: true }
  ```
* namespace
  ```
  { namespace: 'WIX' }
  ```
* name (the same as `searchPhrase` filter. Searches in name, display name and domains)
  ```
  { name: 'my-site' }
  ```
* searchPhrase (the same as `name` filter. Searches in name, display name and domains)
  ```
  { searchPhrase: 'my-site' }
  ```
* state
  ```
  { state: 'ACTIVE' }
  ```
* domainConnected
  ```
  { domainConnected: true }
  ```

## Sort

Sorting can be specified by the following fields:
* createdDate
  ```
  { fieldName: 'createdDate', order: 'ASC' }
  ```
* trashedDate
  ```
  { fieldName: 'trashedDate', order: 'DESC' }
  ```
* updatedDate
  ```
  { fieldName: 'updatedDate', order: 'ASC' }
  ```
* displayName
  ```
  { fieldName: 'displayName', order: 'DESC' }
  ```


Namespace

EditorType

Filter object. See [Filter and Sort](https://dev.wix.com/api/rest/account-level-apis/sites/filter-&-sort) documentation.
Note: the `premium` and `appIds` filters are not supported in this endpoint.

filter

CountSitesRequest

Number of sites retrieved basd on the filter.
Free Wix accounts are limited to max 1,000 sites.
Premium accounts can have an unlimited number of sites.

count

CountSitesResponse

Cursor pointing to next page in the list of results.

Cursors

Number of items returned in the response.

Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used.

PagingMetadataV2

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

QuerySitesRequest

sites

QuerySitesResponse

Filter object with the following format:
`"filter" : {
"displayName": "my-site",
"namespace":{"$in":["value1", "value2"]},
"folderId": {"$exists": false}
}`
Example of operators: `$in`, `$hasSome`, `$hasAll`, `$exists`

Sort object with the following format:
`[{"fieldName":"displayName","order":"ASC"},{"fieldName":"createdDate","order":"DESC"}]`

sort

QueryV2

Paging options to limit and offset the number of items.
wix.common.Paging paging = 3;
Cursor token pointing to a page of results. Used in all calls following the first request.

pagingMethod

Whether Wix has blocked this site due to legal issues.

blocked

contributorAccountIds

createdDate

Site display name. Used for display purposes, such as in the browser's tab name.

displayName

domainConnected

editUrl

editorType

Folder ID that contains this site. Empty if site is at root level.

folderId

htmlAppId

name

namespace

ownerAccountId

Whether the site has a Wix Premium (paid) plan.

premium

published

thumbnail

trashedDate

updatedDate

viewUrl

Site

value

BoolValue

Int32Value

values

ListValue

NullValue

StringValue

fields

Struct

nanos

seconds

Timestamp

Value

boolValue

listValue

nullValue

numberValue

stringValue

structValue

kind

Pointer to the next or previous page in the list of results.

You can get the relevant cursor token
from the `pagingMetadata` object in the previous call's response.
Not relevant for the first request.

cursor

limit

CursorPaging

SortOrder

fieldName

order

Sorting

Retrieves a list of up to 1,000 sites, given the provided [paging, sorting and filtering](https://dev.wix.com/api/rest/account-level-apis/sites/filter-&-sort).

> **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.

Query sites

QuerySites

Retrieves the number of sites, given the provided [filtering](https://dev.wix.com/api/rest/account-level-apis/sites/filter-&-sort).

> **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.

Count sites

CountSites