About the Site Folders API

The Site Folders API enables the management of sites in an account by organizing them into folders.

With the Folders APIs you can create folders, update folder names, and delete folders. You can also get a parent folder’s ID by site ID, and you can move folders and sites between folders.

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 owners and contributors can also manage their sites and folders via the My Sites page.

Terminology

  • Account: A Wix account includes all the assets that site owners/contributors interact with: sites, folders, premium plans, domains, and more. An account can have one or more users. Standard accounts have one user while team accounts can have multiple users.
  • Site: A website in the account. Sites are accessible to site owners and contributors according to the specific permissions they hold on a specific site or on the entire account.
  • Folder: A group of sites that account users can create to organize their sites. Each site can only belong to one folder.

Sample User Flow

An agency that builds Wix sites for customers might set up their folders according to their internal workflow processes, and only share the site with the customer once it has reached a certain stage in the process. In such a situation the flow might look like this:

  1. Call the Create Folder endpoint as often as required to create folders with all your workflow process names, including “Design”, “QA”, “Suspended”, and “Live”.
  2. As the site moves along the workflow process, call the Move Sites to Folder endpoint to move the sites to the relevant folder, for example sites that have completed design and are waiting for QA into the designated "QA" folder.
  3. Periodically get all unpaid site IDs from an external list.
  4. Call the Move Sites to Folder endpoint to move all unpaid sites into the designated "Suspended" folder.
  5. If your process changes, call the Update Folder endpoint to rename a folder.

Limitations

  • Each site can only belong to one folder.
  • Each account can have a maximum of 500 folders in the Wix account (not currently enforced via API).
  • Up to 1,000 folders can be moved by MoveFolders.
  • Up to 500 sites can be moved by MoveSitesToFolder.
  • Up to 1,000 folders can be retrieved by QueryFolders.
Was this helpful?
Yes
No

Folder Object

Properties
idstringRead-onlyformat GUID

Folder ID.


namestring

Folder name.


createdDatestringRead-onlyformat date-time

Date the folder was created.


updatedDatestringRead-onlyformat date-time

Date the folder was last updated.


siteCountintegerRead-only

Number of sites in the folder.


parentIdstring

Parent folder ID. When empty, the site is at root level.


pathArray <FolderBasicInfo>Read-onlymaxItems 50

Path including all parent folders from root to the current folder, in order. When empty, the site or folder is at root level.

Was this helpful?
Yes
No

PostQuery Folders

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 folders, 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-folders/v2/folders/query

Was this helpful?
Yes
No

PostCreate Folder

Developer Preview

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

Creates a folder.

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-folders/v2/folders

Was this helpful?
Yes
No

PatchUpdate Folder

Developer Preview

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

Updates a folder.

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
PATCH
https://www.wixapis.com/site-folders/v2/folders/{folder.id}

Was this helpful?
Yes
No

PatchMove Folders

Developer Preview

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

Move folders to a specific folder or to root level.

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
PATCH
https://www.wixapis.com/site-folders/v2/folders/bulk/move

Was this helpful?
Yes
No

DeleteDelete Folder

Developer Preview

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

Deletes a folder and moves its content to the parent folder (or to root level if no parent folder exists).

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
DELETE
https://www.wixapis.com/site-folders/v2/folders/{id}

Was this helpful?
Yes
No

PostMove Sites To Folder

Developer Preview

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

Moves sites into a specific folder/root. Limited to 500 sites per request.

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-folders/v2/folders/bulk/sites/move

Was this helpful?
Yes
No

GetGet Folder By Site

Developer Preview

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

Returns data about the folder that contains the specified site.

Note: If the specified site is root level, the returned folder object will be empty. 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
GET
https://www.wixapis.com/site-folders/v2/folders/sites/{siteId}

Was this helpful?
Yes
No