List Documents

GET

/database/collections/{collectionId}/documents

database

Get a list of all the user documents. You can use the query params to filter your results. On admin mode, this endpoint will return a list of all of the project's documents. Learn more about different API modes.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://appwrite.io/v1/database/collections//documents'

Response Example

{
    "documents": [
        {
            "$collection": "string",
            "$id": "string",
            "$permissions": {}
        }
    ],
    "sum": 0
}

Request

Path Params

collectionId

string

required

Collection unique ID. You can create a new collection with validation rules using the Database service server integration.

Query Params

filters

array[string]

optional

Array of filter strings. Each filter is constructed from a key name, comparison operator (=, !=, >, <, <=, >=) and a value. You can also use a dot (.) separator in attribute names to filter by child document attributes. Examples: 'name=John Doe' or 'category.$id>=5bed2d152c362'.

limit

integer

optional

Maximum number of documents to return in response. Use this value to manage pagination. By default will return maximum 25 results. Maximum of 100 results allowed per request.

offset

integer

optional

Offset value. The default value is 0. Use this param to manage pagination.

orderField

string

optional

Document field that results will be sorted by.

orderType

string

optional

Order direction. Possible values are DESC for descending order, or ASC for ascending order.

orderCast

string

optional

Order field type casting. Possible values are int, string, date, time or datetime. The database will attempt to cast the order field to the value you pass here. The default value is a string.

string

optional

Search query. Enter any free text search. The database will try to find a match against all document attributes and children. Max length: 256 chars.

Responses

🟢200Documents List

application/json

Body

Documents List

documents

array[object (document) {4}]

required

List of documents.

$collection

string

required

Collection ID.

$id

string

required

Document ID.

$permissions

object

required

Document permissions.

Additional properties

integer | number | string | boolean

optional

sum

integer <int32>

required

Total sum of items in the list.

Modified at 2023-08-16 07:28:13

Get QR Code

Create Document