COLLECTION.FIND

POST 

To retrieve one or multiple documents in a collection.

Request

application/json

Body

op stringrequired

Default value: collection.find

The operation

collection stringrequired

Default value: mycollection

The collection name

match objectrequired

Default value: [object Object]

The matching criteria

filter object

The filter criteria

sort string

Default value: _created_at desc

limit integer

Default value: 100

offset integer

Responses

200

Query response

application/json

Schema

Schema

data object[]
meta object
pagination object
page integer
per_page integer
total_pages integer
size integer
count integer
has_next boolean
next_page integer
has_prev boolean
prev_page integer
page_showing_start integer
page_showing_end integer

Example (from schema)

{
  "data": [
    {}
  ],
  "meta": {
    "pagination": {
      "page": 0,
      "per_page": 0,
      "total_pages": 0,
      "size": 0,
      "count": 0,
      "has_next": true,
      "next_page": 0,
      "has_prev": true,
      "prev_page": 0,
      "page_showing_start": 0,
      "page_showing_end": 0
    }
  }
}

Loading...