Query Document List

GET 
/collections/:collectionName/documents

Query documents in a collection. Supports complex query conditions (MongoDB query syntax), pagination, sorting, and field projection. When count=true, only returns the count of matching documents without the document list.

Request

Path Parameters

collectionName stringrequired

Collection name

Query Parameters

query string

Default value: {}

Query conditions (EJSON string), e.g. {"age":{"$gte":18}}

offset integer

Default value: 0

Offset for pagination

limit integer

Default value: 20

Number of documents per page

order string

Sort rules (JSON string), e.g. [{"field":"age","direction":"desc"}]

projection string

Field projection (JSON string), e.g. {"name":1,"email":1}

count boolean

Set to true to return only the document count

transactionId string

Transaction ID

Responses

200

Query successful

application/json

Schema

Schema

oneOf

MOD1

offset integer

Current offset

limit integer

Documents per page

list object[]

Document list (EJSON format)

MOD2

total integer

Total number of matching documents

Example (from schema)

{}

list

Document list

{
  "offset": 0,
  "limit": 20,
  "list": [
    {
      "_id": {
        "$oid": "507f1f77bcf86cd799439011"
      },
      "name": "John Doe",
      "age": {
        "$numberInt": "30"
      }
    }
  ]
}

count

Count result (count=true)

{
  "total": 42
}

400

Invalid request parameters

application/json

Schema

Schema

code string

Error code

message string

Error message

request_id string

Unique request ID

Example (from schema)

{
  "code": "INVALID_PARAM",
  "message": "param.query can't be empty",
  "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

Loading...