> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# Method name: listDataCollections(options: ListDataCollectionsOptions)

# Method package: wixDataV2

# Method menu location: wixDataV2 --> collections --> listDataCollections

# Method Link: https://dev.wix.com/docs/velo/apis/wix-data-v2/collections/list-data-collections.md

# Method Description:

Retrieves a list of all data collections associated with the site or project.

By default, the list is ordered by ID in ascending order.



# Method Code Examples:

*** Note: do not assume any prop names or enum values other than the ones in the example.

## Lists existing collections (dashboard page code)

```javascript
import { collections } from "wix-data.v2";

export async function myListDataCollectionsFunction(options) {  
  try {
    const myDataCollections = await collections.listDataCollections();
    return myDataCollections;
  } catch (error) {
    console.error(error);
    // Handle the error 
  } 
}

/* Returns a promise that resolves to a list of existing data collections: 
* {
*   "collections": [
*     // ...
*     {
*       "_id": "myMusicCollection",
*       "collectionType": "NATIVE",
*       "displayName": "My Music Collection",
*       "displayField": "myMusicCollection",
*       "capabilities": {
*         "dataOperations": [
*           "IS_REFERENCED",
*           "INSERT",
*           "SAVE",
*           "BULK_INSERT",
*           "BULK_UPDATE",
*           "UPDATE",
*           "TRUNCATE",
*           "REMOVE",
*           "REMOVE_REFERENCE",
*           "COUNT",
*           "FIND",
*           "REPLACE_REFERENCES",
*           "BULK_REMOVE",
*           "INSERT_REFERENCE",
*           "GET",
*           "BULK_SAVE",
*           "QUERY_REFERENCED",
*           "DISTINCT",
*           "AGGREGATE"
*         ],
*         "collectionOperations": [
*           "UPDATE",
*           "REMOVE"
*         ],
*         "indexLimits": {
*           "regular": 3,
*           "unique": 1,
*           "total": 4
*         }
*       },
*       "fields": 
*       [
*         {
*           "key": "artist",
*           "displayName": "Artist Name",
*           "type": "TEXT",
*           "systemField": false,
*           "capabilities": {
*             "sortable": true,
*             "queryOperators": [
*               "EQ",
*               "LT",
*               "GT",
*               "NE",
*               "LTE",
*               "GTE",
*               "STARTS_WITH",
*               "ENDS_WITH",
*               "CONTAINS",
*               "HAS_SOME",
*               "HAS_ALL",
*               "EXISTS",
*               "URLIZED"
*             ]
*           },
*           "encrypted": false,
*           "description": "The artist's name"
*         },
*         {
*           "key": "_id",
*           "displayName": "ID",
*           "type": "TEXT",
*           "systemField": true,
*           "capabilities": {
*             "sortable": true,
*             "queryOperators": [
*               "EQ",
*               "LT",
*               "GT",
*               "NE",
*               "LTE",
*               "GTE",
*               "STARTS_WITH",
*               "ENDS_WITH",
*               "CONTAINS",
*               "HAS_SOME",
*               "HAS_ALL",
*               "EXISTS",
*               "URLIZED"
*             ]
*           },
*           "encrypted": false
*         },
*         // Additional system fields ...
*       ],
*       "permissions": {
*         "insert": "SITE_MEMBER_AUTHOR",
*         "update": "SITE_MEMBER_AUTHOR",
*         "remove": "SITE_MEMBER_AUTHOR",
*         "read": "ANYONE"
*       },
*       "revision": "1",
*       "plugins": [],
*       "pagingModes": [
*         "OFFSET"
*       ],
*       "_createdDate": "2023-07-19T12:40:02.372Z",
*       "_updatedDate": "2023-07-19T12:40:02.372Z"
*     }
*   ],
*   "pagingMetadata": {
*     "count": 18,
*     "offset": 0,
*     "total": 18,
*     "tooManyToCount": false
*   }
* }; 
* */

```

## Lists existing collections (export from backend code)

```javascript
import { Permissions, webMethod } from 'wix-web-module';
import { collections } from 'wix-data.v2';

export const myListDataCollectionsFunction = webMethod(Permissions.Anyone, async (options) => {
  try {
    const myDataCollections = await collections.listDataCollections();
    return myDataCollections;
  } catch (error) {
    console.error(error);
    // Handle the error 
  } 
});

/* Returns a promise that resolves to a list of existing data collections: 
* {
*   "collections": [
*     // ...
*     {
*       "_id": "myMusicCollection",
*       "collectionType": "NATIVE",
*       "displayName": "My Music Collection",
*       "displayField": "myMusicCollection",
*       "capabilities": {
*         "dataOperations": [
*           "IS_REFERENCED",
*           "INSERT",
*           "SAVE",
*           "BULK_INSERT",
*           "BULK_UPDATE",
*           "UPDATE",
*           "TRUNCATE",
*           "REMOVE",
*           "REMOVE_REFERENCE",
*           "COUNT",
*           "FIND",
*           "REPLACE_REFERENCES",
*           "BULK_REMOVE",
*           "INSERT_REFERENCE",
*           "GET",
*           "BULK_SAVE",
*           "QUERY_REFERENCED",
*           "DISTINCT",
*           "AGGREGATE"
*         ],
*         "collectionOperations": [
*           "UPDATE",
*           "REMOVE"
*         ],
*         "indexLimits": {
*           "regular": 3,
*           "unique": 1,
*           "total": 4
*         }
*       },
*       "fields": 
*       [
*         {
*           "key": "artist",
*           "displayName": "Artist Name",
*           "type": "TEXT",
*           "systemField": false,
*           "capabilities": {
*             "sortable": true,
*             "queryOperators": [
*               "EQ",
*               "LT",
*               "GT",
*               "NE",
*               "LTE",
*               "GTE",
*               "STARTS_WITH",
*               "ENDS_WITH",
*               "CONTAINS",
*               "HAS_SOME",
*               "HAS_ALL",
*               "EXISTS",
*               "URLIZED"
*             ]
*           },
*           "encrypted": false,
*           "description": "The artist's name"
*         },
*         {
*           "key": "_id",
*           "displayName": "ID",
*           "type": "TEXT",
*           "systemField": true,
*           "capabilities": {
*             "sortable": true,
*             "queryOperators": [
*               "EQ",
*               "LT",
*               "GT",
*               "NE",
*               "LTE",
*               "GTE",
*               "STARTS_WITH",
*               "ENDS_WITH",
*               "CONTAINS",
*               "HAS_SOME",
*               "HAS_ALL",
*               "EXISTS",
*               "URLIZED"
*             ]
*           },
*           "encrypted": false
*         },
*         // Additional system fields ...
*       ],
*       "permissions": {
*         "insert": "SITE_MEMBER_AUTHOR",
*         "update": "SITE_MEMBER_AUTHOR",
*         "remove": "SITE_MEMBER_AUTHOR",
*         "read": "ANYONE"
*       },
*       "revision": "1",
*       "plugins": [],
*       "pagingModes": [
*         "OFFSET"
*       ],
*       "_createdDate": "2023-07-19T12:40:02.372Z",
*       "_updatedDate": "2023-07-19T12:40:02.372Z"
*     }
*   ],
*   "pagingMetadata": {
*     "count": 18,
*     "offset": 0,
*     "total": 18,
*     "tooManyToCount": false
*   }
* }; 
* */

```

## List up to 10 existing data collections with a given offest 

```javascript
import { Permissions, webMethod } from "wix-web-module";
import { collections } from "wix-data.v2";

/* Sample options parameter:
 *
 * const options = {
 *   paging: {
 *     limit: 10, 
 *     offset: 1
 *   }
 * };
 */ 

export const myListDataCollectionsFunctionAdv = webMethod(Permissions.Anyone, async (options) => {
  try {
    const ListDataCollectionsResponse = await collections.listDataCollections(options);
    return ListDataCollectionsResponse;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
});

/* Returns a promise that resolves to a list of existing data collections:
 * {
 *   "collections": [
 *     ...
 *     // List of collections, starting with the second collection
 *     ...
 *     {           
 *       "_id": "Members/FullData",
 *       "collectionType": "WIX_APP",
 *       "ownerAppId": "14cc59bc-f0b7-15b8-e1c7-89ce41d0e0c9",
 *       "displayName": "FullData",
 *       "defaultDisplayOrder": {
 *         "fieldKey": "_createdDate",
 *         "direction": "ASC"
 *       },
 *       "displayNamespace": "Members",
 *       "displayField": "loginEmail",
 *       "capabilities": {
 *         "dataOperations": [
 *           "UPDATE",
 *           "REMOVE",
 *           "COUNT",
 *           "FIND",
 *           "GET"
 *         ],
 *         "collectionOperations": []
 *       },
 *       "fields": 
 *       [
 *         {
 *           "key": "_id",
 *           "displayName": "ID",
 *           "type": "TEXT",
 *           "systemField": true,
 *           "capabilities": {
 *             "sortable": false,
 *             "queryOperators": [
 *               "EQ",
 *               "HAS_SOME",
 *               "CONTAINS",
 *               "URLIZED"
 *             ]
 *           },
 *           "encrypted": false
 *         },
 *         {
 *           "key": "loginEmail",
 *           "displayName": "Login Email",
 *           "type": "TEXT",
 *           "systemField": true,
 *           "capabilities": {
 *             "sortable": false,
 *             "queryOperators": [
 *               "EQ",
 *               "HAS_SOME",
 *               "CONTAINS"
 *             ]
 *           },
 *           "encrypted": false
 *         },
 *         {
 *           "key": "firstName",
 *           "displayName": "First Name",
 *           "type": "TEXT",
 *           "systemField": false,
 *           "capabilities": {
 *             "sortable": true,
 *             "queryOperators": [
 *               "EQ",
 *               "HAS_SOME",
 *               "CONTAINS"
 *             ]
 *           },
 *           "encrypted": false
 *         },
 *         {
 *           "key": "lastName",
 *           "displayName": "Last Name",
 *           "type": "TEXT",
 *           "systemField": false,
 *           "capabilities": {
 *             "sortable": true,
 *             "queryOperators": [
 *               "EQ",
 *               "HAS_SOME",
 *               "CONTAINS"
 *             ]
 *           },
 *           "encrypted": false
 *         },
 *         {
 *           "key": "phone",
 *           "displayName": "Phone",
 *           "type": "TEXT",
 *           "systemField": true,
 *           "capabilities": {
 *             "sortable": false,
 *             "queryOperators": []
 *           },
 *           "encrypted": false
 *         },
 *         {
 *           "key": "email",
 *           "displayName": "Email",
 *           "type": "TEXT",
 *           "systemField": true,
 *           "capabilities": {
 *             "sortable": false,
 *             "queryOperators": []
 *           },
 *           "encrypted": false
 *         },
 *         {
 *           "key": "nickname",
 *           "displayName": "Nickname",
 *           "type": "TEXT",
 *           "systemField": false,
 *           "capabilities": {
 *             "sortable": true,
 *             "queryOperators": [
 *               "EQ",
 *               "HAS_SOME",
 *               "CONTAINS"
 *             ]
 *           },
 *           "encrypted": false
 *         },
 *         {
 *           "key": "slug",
 *           "displayName": "Slug",
 *           "type": "TEXT",
 *           "systemField": true,
 *           "capabilities": {
 *             "sortable": false,
 *             "queryOperators": [
 *               "EQ"
 *             ]
 *           },
 *           "encrypted": false
 *         },
 *         {
 *           "key": "profilePhoto",
 *           "displayName": "Profile Photo",
 *           "type": "IMAGE",
 *           "systemField": false,
 *           "capabilities": {
 *             "sortable": false,
 *             "queryOperators": []
 *           },
 *           "encrypted": false
 *         },
 *         {
 *           "key": "coverPhoto",
 *           "displayName": "Cover Photo",
 *           "type": "IMAGE",
 *           "systemField": false,
 *           "capabilities": {
 *             "sortable": false,
 *             "queryOperators": []
 *           },
 *           "encrypted": false
 *         },
 *         {
 *           "key": "status",
 *           "displayName": "Status",
 *           "type": "TEXT",
 *           "systemField": true,
 *           "capabilities": {
 *             "sortable": false,
 *             "queryOperators": []
 *           },
 *           "encrypted": false
 *         },
 *         {
 *           "key": "privacyStatus",
 *           "displayName": "Privacy Status",
 *           "type": "TEXT",
 *           "systemField": true,
 *           "capabilities": {
 *             "sortable": false,
 *             "queryOperators": []
 *           },
 *           "encrypted": false
 *         },
 *         {
 *           "key": "activityStatus",
 *           "displayName": "Activity Status",
 *           "type": "TEXT",
 *           "systemField": true,
 *           "capabilities": {
 *             "sortable": false,
 *             "queryOperators": []
 *           },
 *           "encrypted": false
 *         },
 *         {
 *           "key": "lastLoginDate",
 *           "displayName": "Last Login Date",
 *           "type": "DATETIME",
 *           "systemField": true,
 *           "capabilities": {
 *             "sortable": true,
 *             "queryOperators": []
 *           },
 *           "encrypted": false
 *         },
 *         {
 *           "key": "_createdDate",
 *           "displayName": "Creation Date",
 *           "type": "DATETIME",
 *           "systemField": true,
 *           "capabilities": {
 *             "sortable": true,
 *             "queryOperators": []
 *           },
 *           "encrypted": false
 *         },
 *         {
 *           "key": "_updatedDate",
 *           "displayName": "Last Updated",
 *           "type": "DATETIME",
 *           "systemField": true,
 *           "capabilities": {
 *             "sortable": false,
 *             "queryOperators": []
 *           },
 *           "encrypted": false
 *         }
 *       ],
 *       "permissions": {
 *         "insert": "ADMIN",
 *         "update": "ADMIN",
 *         "remove": "ADMIN",
 *         "read": "ANYONE"
 *       },
 *       "revision": "0",
 *       "plugins": [],
 *       "pagingModes": [
 *         "OFFSET"
 *       ]
 *     }
 *   ],
 *   "pagingMetadata": {
 *     "count": 10,
 *     "offset": 1,
 *     "total": 18,
 *     "tooManyToCount": false
 *   }
 * };
 */ 

```

---