# 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' }
  ```

Coding Examples

Sled Tests

Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

API Reference

Velo

Picasso

GraphQL (Alpha)

Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default.

ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default.

MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default.

Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default.

Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default.

Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default.

A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default.

AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.

LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default.

VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default.

MetaSites with this namespace will *not* be shown in a user's site list by default.

A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.

Meta site with this namespace will *not* be shown in a user's site list by default.

the user-journey for Fitness users who want to start from managing their business instead of designing their website.
Will be accessible from Site List and will not have a website app.
Once the user attaches a site, the site will become a regular wixsite.

Belongs to "strategic products" company. Supports new product in the creator's economy space.

It is to be used in the Business First efforts.

Namespace for Headless Backoffice with no editor

Namespace for master site that will exist in parent account that will be referenced by subaccounts
The site will be used for account level CSM feature for enterprise

Rise.ai Siteless account management for Gift Cards and Store Credit.

As part of the branded app new funnel, users now can create a meta site that will be branded app first.
There's a blank site behind the scene but it's blank).
The Mobile company will be the owner of this namespace.

Nownia.com Siteless account management for Ai Scheduling Assistant.

UGC Templates are templates that are created by users for personal use and to sale to other users.
The Partners company owns this namespace.

Shared Blog Site is a unique single site across Enterprise account,
This site will hold all Blog posts related to the Marketing product.

Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default.

Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default.

MIMIR - Siteless account for MIMIR Ai Job runner.

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.

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

cursor

Maximum number of items to return in the results.

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**: You can only call this method when authenticated as a Wix user or by using an account level API key.

Query sites

QuerySites

import { sites } from '@wix/sites';

async function querySites(options) {
  const response = await sites.querySites(options);
};

querySites

import { sites } from '@wix/sites';
import { auth } from '@wix/essentials';

async function myQuerySitesMethod(options) {
  const elevatedQuerySites = auth.elevate(sites.querySites);
  const response = await elevatedQuerySites(options);
}

querySites (with elevated permissions)

import { createClient } from '@wix/sdk';
import { sites } from '@wix/sites';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { sites },
  // Include the auth strategy and host as relevant
});


async function querySites(options) {
  const response = await myWixClient.sites.querySites(options);
};

Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).

querySites (self-hosted)

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

> **Important**: You can only call this method when authenticated as a Wix user or by using an account level API key.

Count sites

CountSites

import { sites } from '@wix/sites';

async function countSites(options) {
  const response = await sites.countSites(options);
};

countSites

import { sites } from '@wix/sites';
import { auth } from '@wix/essentials';

async function myCountSitesMethod(options) {
  const elevatedCountSites = auth.elevate(sites.countSites);
  const response = await elevatedCountSites(options);
}

countSites (with elevated permissions)

import { createClient } from '@wix/sdk';
import { sites } from '@wix/sites';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { sites },
  // Include the auth strategy and host as relevant
});


async function countSites(options) {
  const response = await myWixClient.sites.countSites(options);
};