Query records

Returns records matching a MongoDB-style filter, with sorting, pagination, and field projection. Operators executing code or cross-referencing data ($where, $function, $expr, $lookup, $merge, $accumulator, $out) are rejected.

Text equality is exact and case-sensitive: {"category":"informatique"} will not match a stored Informatique. For case-insensitive matching use a regex, e.g. {"category":{"$regex":"^informatique$","$options":"i"}}, or call the distinct endpoint first to get the exact stored value. Rate limit: 100 requests/min per user.

GET /v1/collections/{collection_id}/data

Query records

cURL

curl --request GET \
  --url https://{host}/v2/workspaces/slug:ai-collection-v3/webhooks/v1/collections/{collection_id}/data \
  --header 'Authorization: Bearer <token>'

200

{
  "count": 123,
  "records": [
    {
      "_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

BearerAuthOrgApiKeyAuth

Authorization · string · header · required

User session JWT. Send as Authorization: Bearer <token>.

Path Parameters

collection_id · string<uuid> · required

Collection identifier returned at creation.

Query Parameters

filter · string

JSON-encoded MongoDB-style filter.

sort · string

JSON-encoded sort specification.

limit · integer · default: 20

Page size (max 100).

Required range: 1 <= x <= 100

page · integer · default: 1

Page number.

Required range: x >= 1

fields · string

JSON-encoded field projection.

Response

200

application/json

Matching records.

count · integer

Number of records in this page.

records · object[]

Hide child attributes

records. _id · string

records. created_at · string<date-time>

records. updated_at · string<date-time>