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.
Was this helpful?
Yes
No

Filter

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

  • id
    Copy
    1
    { id: { $in: ['015c25c0-24e8-4966-a951-a3b458da7351', '04067d48-5b6c-48b5-9c08-8397d7e8d53a'] } }
  • folderId
    • filter sites that are in root level (no folder):
      Copy
      1
      { folderId: { $exists: false } }
    • filter sites that are in a specific folder:
      Copy
      1
      { folderId: '54915d80-62c2-4791-8483-88541ed18a60' }
  • editorType
    Copy
    1
    { editorType: 'EDITOR' }
  • appIds
    • filter sites that have provided app ids:
      Copy
      1
      { 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
      1
      { appIds: { $hasSome: ['1dbbce47-77b4-4ccf-be8c-8434eab7f58d', '87beaf91-cf01-4209-93ed-eb7cc47dc2cf' ] } }
  • premium
    Copy
    1
    { premium: true }
  • published
    Copy
    1
    { published: true }
  • namespace
    Copy
    1
    { namespace: 'WIX' }
  • name (the same as searchPhrase filter. Searches in name, display name and domains)
    Copy
    1
    { name: 'my-site' }
  • searchPhrase (the same as name filter. Searches in name, display name and domains)
    Copy
    1
    { searchPhrase: 'my-site' }
  • state
    Copy
    1
    { state: 'ACTIVE' }
  • domainConnected
    Copy
    1
    { domainConnected: true }

Sort

Sorting can be specified by the following fields:

  • createdDate
    Copy
    1
    { fieldName: 'createdDate', order: 'ASC' }
  • trashedDate
    Copy
    1
    { fieldName: 'trashedDate', order: 'DESC' }
  • updatedDate
    Copy
    1
    { fieldName: 'updatedDate', order: 'ASC' }
  • displayName
    Copy
    1
    { fieldName: 'displayName', order: 'DESC' }
Was this helpful?
Yes
No

Site Object

Attributes
idstringformat GUID
Site ID.

htmlAppIdstringformat GUID
HTML app ID for the site.

namestring
Site name. Used in the site's URL.

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

createdDatestringformat date-time
Site creation date.

updatedDatestringformat date-time
Site updated date.

trashedDatestringformat date-time
Site trashed date.

publishedboolean
Whether the site is published.

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

viewUrlstring
Live site URL.

editUrlstring
Editor site URL.

thumbnailstring
Site thumbnail.

ownerAccountIdstringformat GUID
Site owner's account ID.

contributorAccountIdsArray <string>format GUIDminItems 1maxItems 1000
Site contributors' account IDs.

editorTypestring
5 supported values:
UNKNOWNEDITORADIEDITORXSTUDIO
Site's Wix editor type.

blockedboolean
Whether Wix has blocked this site due to legal issues.

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

namespacestring
20 supported values:
UNKNOWN_NAMESPACEWIXSHOUT_OUTALBUMSWIX_STORES_TEST_DRIVEHOTELSCLUBSONBOARDING_DRAFTDEV_SITELOGOSVIDEO_MAKERPARTNER_DASHBOARDDEV_CENTER_COMPANYHTML_DRAFTSITELESS_BUSINESSCREATOR_ECONOMYDASHBOARD_FIRSTANYWHEREHEADLESSACCOUNT_MASTER_CMS
Namespace of the site, for internal use.

domainConnectedboolean
Whether the site has a connected domain.
Was this helpful?
Yes
No

PostQuery Sites

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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.

Endpoint
POST
https://www.wixapis.com/site-list/v2/sites/query

Was this helpful?
Yes
No

PostCount Sites

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves the number of sites, given the provided 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.

Endpoint
POST
https://www.wixapis.com/site-list/v2/sites/count

Was this helpful?
Yes
No