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.

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

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

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

Both the Query Sites and Count Sites endpoints accept the following filters:

• id

  Copy Code
  { id: { $in: ['015c25c0-24e8-4966-a951-a3b458da7351', '04067d48-5b6c-48b5-9c08-8397d7e8d53a'] } }

• folderId
  • filter sites that are in root level (no folder):

    Copy Code
    { folderId: { $exists: false } }

  • filter sites that are in a specific folder:

    Copy Code
    { folderId: '54915d80-62c2-4791-8483-88541ed18a60' }

• editorType

  Copy Code
  { editorType: 'EDITOR' }

• appIds
  • filter sites that have provided app ids:

    Copy Code
    { appIds: { $hasAll: ['1dbbce47-77b4-4ccf-be8c-8434eab7f58d', '87beaf91-cf01-4209-93ed-eb7cc47dc2cf' ] } }

  • filter sites that have at least one of the provided app ids:

    Copy Code
    { appIds: { $hasSome: ['1dbbce47-77b4-4ccf-be8c-8434eab7f58d', '87beaf91-cf01-4209-93ed-eb7cc47dc2cf' ] } }

• premium

  Copy Code
  { premium: true }

• published

  Copy Code
  { published: true }

• namespace

  Copy Code
  { namespace: 'WIX' }

• name (the same as searchPhrase filter. Searches in name, display name and domains)

  Copy Code
  { name: 'my-site' }

• searchPhrase (the same as name filter. Searches in name, display name and domains)

  Copy Code
  { searchPhrase: 'my-site' }

• state

  Copy Code
  { state: 'ACTIVE' }

• domainConnected

  Copy Code
  { domainConnected: true }

Sorting can be specified by the following fields:

• createdDate

  Copy Code
  { fieldName: 'createdDate', order: 'ASC' }

• trashedDate

  Copy Code
  { fieldName: 'trashedDate', order: 'DESC' }

• updatedDate

  Copy Code
  { fieldName: 'updatedDate', order: 'ASC' }

• displayName

  Copy Code
  { fieldName: 'displayName', order: 'DESC' }