POST

Query 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
Body Params
queryQuery

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

Response Object
sitesArray <Site>

List of retrieved sites.

cursorPagingCursorPaging

Paging information.

metadataMetadata

Meta data about the returned sites

Query sites
Request
cURL
curl -X POST 'https://www.wixapis.com/site-list/v2/sites/query' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json, text/plain, */*' \
  -H 'Authorization: <AUTH>' \
  -H 'wix-account-id: <ACCOUNT ID>'
 --data-raw '{
    "query": {
      "filter":{"editorType":"EDITOR"},
      "sort":[{ "fieldName": "createdDate", "order": "ASC" }],
      "cursorPaging": {"limit": 2}
    }}' \
Response
JSON
{
  "sites": [
    {
      "id": "0c87cd5d-4059-4e86-8f6e-d185b1e4a1bd",
      "htmlAppId": "cdb52656-4acf-409a-a59a-953d91eb9332",
      "name": "abc",
      "displayName": "abc",
      "createdDate": "2015-04-19T15:22:42.498Z",
      "published": true,
      "premium": false,
      "viewUrl": "https://example-user.wixsite.com/abc",
      "editUrl": "/editor/0c87cd5d-4059-4e86-8f6e-d185b124a1bd?editorSessionId=2b550f0c-5ff7-49fd-80ed-fb2eb7d7bbe5",
      "thumbnail": "/site-thumbnail/0c87cd5d-4059-4e86-826e-d185b1e4a1bd",
      "ownerAccountId": "99714651-d974-4878-aa0a-1cd1d7341156",
      "contributorAccountIds": [
        "ffd39125-a3e7-3aca-8c53-ca4ad1c55044",
        "cc2df366-9402-4e19-aa4a-4857e6d55280"
      ],
      "editorType": "EDITOR",
      "blocked": false,
      "folderId": "cc2df366-9402-4e19-aa4a-4857e6d55230",
      "namespace": "WIX",
      "domainConnected": false
    },
    {
      "id": "79f8da2d-d56e-4962-b999-548f7bad2c41",
      "htmlAppId": "cf12cd75-08b0-4d33-8a42-9c13dd5c188e",
      "name": "test",
      "displayName": "test",
      "createdDate": "2015-06-01T11:04:44.024Z",
      "published": true,
      "premium": false,
      "viewUrl": "https://example-user.wixsite.com/test",
      "editUrl": "/editor/79f8da2d-d53e-4962-b999-548f7bad4c41?editorSessionId=962a38e4-ae8b-47c6-918e-8ae19505b82f",
      "thumbnail": "/site-thumbnail/71f8da2d-d56e-4962-b999-548f7bad4c41",
      "ownerAccountId": "99714651-d968-4878-aa0a-1cd1d73f1156",
      "contributorAccountIds": ["99714651-d974-4878-aa0a-1cded73f1156"],
      "editorType": "EDITOR",
      "blocked": false,
      "namespace": "WIX",
      "domainConnected": false
    }
  ],
  "cursorPaging": {
    "cursor": "{\"id\":\"79f4da2d-d56e-4962-b999-548f7bad4c41\",\"createDate\":1433156684024,\"updateDate\":1609363244895,\"siteDisplayName\":\"test\"}"
  },
  "metadata": {
    "count": 2,
    "cursors": {
      "next": "79f4da2d-d56e-4962-b999-548f7bad4c41"
    },
    "hasNext": true
  }
}
Errors
401Unauthenticated

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?