GET

List Indexes


Lists all indexes defined for a data collection.

When an index's status is ACTIVE, it is ready to use. While it is still being created, its status is BUILDING.

When an index's status is DROPPED, it has been dropped successfully. While it is still in the process of being removed, its status is DROPPING.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Data Indexes
Manage All Data Resources
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/wix-data/v2/indexes

Query Params
dataCollectionIdstringRequired

ID of the data collection for which to list indexes.


paging.limitintegerminimum 0format int32

Number of items to load.


paging.offsetintegerminimum 0format int32

Number of items to skip in the current sort order.

Response Object
indexesArray <Index>

List of all indexes for the requested data collection.


pagingMetadataPagingMetadata

Paging metadata.

Request
cURL
Response
JSON
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?