Collections

List Collections

GET
/v2/collections
x-api-key<token>

Authenticate using API Key in request header

In: header

Query Parameters

parentCollectionName?string

Optional filter to list only collections under a specific parent collection path. For example, "customers" will return "customers", "customers.premium", "customers.premium.vip", etc.

collectionNameSearch?string

Optional substring search filter for collection names (case-insensitive). For example, "premium" will match "customers.premium", "products.premium", etc.

page?integer

Page number for pagination

Default1
Range1 <= value
limit?integer

Number of collections per page

Default50
Range1 <= value <= 100

Response Body

application/json

curl -X GET "https://api.bem.ai/v2/collections"
{
  "collections": [
    {
      "collectionID": "string",
      "collectionName": "string",
      "itemCount": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "page": 0,
  "limit": 0,
  "totalCount": 0,
  "totalPages": 0
}