Get All Documents

This is a cURL request to a database named "Example" on our playground server. Paging through all of the documents in the database, the request skips the first 9 documents and retrieves the next 2.

curl -X GET "http://live-test.ravendb.net/databases/Example/docs?start=9&pageSize=2"

Response:

HTTP/1.1 200 OK
Server: nginx 
Date: Thu, 10 Oct 2019 12:00:40 GMT 
Content-Type: application/json; charset=utf-8 
Transfer-Encoding: chunked 
Connection: keep-alive 
Content-Encoding: gzip 
ETag: "A:2134-W33iO0zJC0qZKWh6fjnp6A, A:1887-0N64iiIdYUKcO+yq1V0cPA, A:6214-xwmnvG1KBkSNXfl7/0yJ1A" 
Vary: Accept-Encoding 
Raven-Server-Version: 4.2.4.42 

{
    "Results": [
        {
            "Name": "Seafood",
            "Description": "Seaweed and fish",
            "@metadata": {
                "@attachments": [
                    {
                        "Name": "image.jpg",
                        "Hash": "GWdpGVCWyLsrtNdA5AOee0QOZFG6rKIqCosZZN5WnCA=",
                        "ContentType": "image/jpeg",
                        "Size": 33396
                    }
                ],
                "@collection": "Categories",
                "@change-vector": "A:2107-W33iO0zJC0qZKWh6fjnp6A",
                "@flags": "HasAttachments",
                "@id": "categories/8-A",
                "@last-modified": "2018-07-27T12:21:39.1315788Z"
            }
        },
        {
            "Name": "Produce",
            "Description": "Dried fruit and bean curd",
            "@metadata": {
                "@attachments": [
                    {
                        "Name": "image.jpg",
                        "Hash": "asY7yUHhdgaVoKhivgua0OUSJKXqNDa3Z1uLP9XAocM=",
                        "ContentType": "image/jpeg",
                        "Size": 61749
                    }
                ],
                "@collection": "Categories",
                "@change-vector": "A:2104-W33iO0zJC0qZKWh6fjnp6A",
                "@flags": "HasAttachments",
                "@id": "categories/7-A",
                "@last-modified": "2018-07-27T12:21:11.2283909Z"
            }
        }
    ]
}

This is the general format of a cURL request that uses all query string parameters:

curl -X GET "<server URL>/databases/<database name>/docs?
            &start=<integer>
            &pageSize=<integer>
            &metadataOnly=<boolean>"
--header "If-None-Match: <hash>"

Query String Parameters

Headers

Http Status Codes

Headers

Body

Retrieved documents are sorted in descending order of their change vectors. A retrieved document is identical in contents and format to the document stored in the server - unless the metadataOnly parameter is set to true.

This is the general format of the JSON response body:

{
    "Results": [
        {
            "<field>":"<value>",
            ...
            "@metadata":{
                ...
            }
        },
        { <document contents> },
        ...
    ]
}

About Northwind, the database used in our examples.

In this section:

• start
• pageSize
• metadataOnly

start

Skip first 1,057 documents, and retrieve the rest (our version of Northwind contains 1,059 documents).
cURL request:

curl -X GET "http://live-test.ravendb.net/databases/Example/docs?start=1057"

Response:

HTTP/1.1 200 OK
Server: nginx
Date: Thu, 10 Oct 2019 16:30:37 GMT
Content-Type: application/json; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Content-Encoding: gzip
ETag: "A:2134-W33iO0zJC0qZKWh6fjnp6A, A:1887-0N64iiIdYUKcO+yq1V0cPA, A:6214-xwmnvG1KBkSNXfl7/0yJ1A"
Vary: Accept-Encoding
Raven-Server-Version: 4.2.4.42

{
    "Results": [
        {
            "ExternalId": "ALFKI",
            "Name": "Alfreds Futterkiste",
            "Contact": {
                "Name": "Maria Anders",
                "Title": "Sales Representative"
            },
            "Address": {
                "Line1": "Obere Str. 57",
                "Line2": null,
                "City": "Berlin",
                "Region": null,
                "PostalCode": "12209",
                "Country": "Germany",
                "Location": {
                    "Latitude": 53.24939,
                    "Longitude": 14.43286
                }
            },
            "Phone": "030-0074321",
            "Fax": "030-0076545",
            "@metadata": {
                "@collection": "Companies",
                "@change-vector": "A:3-W33iO0zJC0qZKWh6fjnp6A",
                "@id": "companies/1-A",
                "@last-modified": "2018-07-27T12:11:53.0182893Z"
            }
        },
        {
            "Max": 8,
            "@metadata": {
                "@collection": "@hilo",
                "@change-vector": "A:1-W33iO0zJC0qZKWh6fjnp6A",
                "@id": "Raven/Hilo/categories",
                "@last-modified": "2018-07-27T12:11:53.0145929Z"
            }
        }
    ]
}

pageSize

Retrieve the first document.
cURL request:

curl -X GET "http://live-test.ravendb.net/databases/Example/docs?pageSize=1"

Response:

HTTP/1.1 200 OK
Server: nginx
Date: Thu, 10 Oct 2019 16:33:31 GMT
Content-Type: application/json; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Content-Encoding: gzip
ETag: "A:2134-W33iO0zJC0qZKWh6fjnp6A, A:1887-0N64iiIdYUKcO+yq1V0cPA, A:6214-xwmnvG1KBkSNXfl7/0yJ1A"
Vary: Accept-Encoding
Raven-Server-Version: 4.2.4.42

{
    "Results": [
        {
            "LastName": "Callahan",
            "FirstName": "Laura",
            "Title": "Inside Sales Coordinator",
            "Address": {
                "Line1": "4726 - 11th Ave. N.E.",
                "Line2": null,
                "City": "Seattle",
                "Region": "WA",
                "PostalCode": "98105",
                "Country": "USA",
                "Location": {
                    "Latitude": 47.664164199999988,
                    "Longitude": -122.3160148
                }
            },
            "HiredAt": "1994-03-05T00:00:00.0000000",
            "Birthday": "1958-01-09T00:00:00.0000000",
            "HomePhone": "(206) 555-1189",
            "Extension": "2344",
            "ReportsTo": "employees/2-A",
            "Notes": [
                "Laura received a BA in psychology from the University of Washington.  She has also completed a course in business French.  She reads and writes French."
            ],
            "Territories": [
                "19428",
                "44122",
                "45839",
                "53404"
            ],
            "@metadata": {
                "@attachments": [
                    {
                        "Name": "photo.jpg",
                        "Hash": "8dte+O8Ds9RJx8dKruWurqapAojM/ZxjHBMst9wm5sI=",
                        "ContentType": "image/jpeg",
                        "Size": 14446
                    }
                ],
                "@collection": "Employees",
                "@change-vector": "A:2134-W33iO0zJC0qZKWh6fjnp6A",
                "@flags": "HasAttachments",
                "@id": "employees/8-A",
                "@last-modified": "2018-07-27T12:26:25.0179915Z"
            }
        }
    ]
}

metadataOnly

Skip first 123 documents, take the next 5, and retrieve only the metadata of each document.
cURL request:

curl -X GET "http://live-test.ravendb.net/databases/Example/docs?
                start=123
                &pageSize=5
                &metadataOnly=true"

Response:

HTTP/1.1 200 OK
Server: nginx
Date: Thu, 10 Oct 2019 16:50:00 GMT
Content-Type: application/json; charset=utf-8
Connection: keep-alive
ETag: "A:2134-W33iO0zJC0qZKWh6fjnp6A, A:1887-0N64iiIdYUKcO+yq1V0cPA, A:6214-xwmnvG1KBkSNXfl7/0yJ1A"
Vary: Accept-Encoding
Raven-Server-Version: 4.2.4.42
Content-Length: 918

{
    "Results": [
        {
            "@metadata": {
                "@collection": "Orders",
                "@change-vector": "A:1871-W33iO0zJC0qZKWh6fjnp6A",
                "@flags": "HasRevisions",
                "@id": "orders/728-A",
                "@last-modified": "2018-07-27T12:11:53.1753957Z"
            }
        },
        {
            "@metadata": {
                "@collection": "Orders",
                "@change-vector": "A:1869-W33iO0zJC0qZKWh6fjnp6A",
                "@flags": "HasRevisions",
                "@id": "orders/727-A",
                "@last-modified": "2018-07-27T12:11:53.1751418Z"
            }
        },
        {
            "@metadata": {
                "@collection": "Orders",
                "@change-vector": "A:1867-W33iO0zJC0qZKWh6fjnp6A",
                "@flags": "HasRevisions",
                "@id": "orders/726-A",
                "@last-modified": "2018-07-27T12:11:53.1749721Z"
            }
        },
        {
            "@metadata": {
                "@collection": "Orders",
                "@change-vector": "A:1865-W33iO0zJC0qZKWh6fjnp6A",
                "@flags": "HasRevisions",
                "@id": "orders/725-A",
                "@last-modified": "2018-07-27T12:11:53.1747646Z"
            }
        },
        {
            "@metadata": {
                "@collection": "Orders",
                "@change-vector": "A:1863-W33iO0zJC0qZKWh6fjnp6A",
                "@flags": "HasRevisions",
                "@id": "orders/724-A",
                "@last-modified": "2018-07-27T12:11:53.1745710Z"
            }
        }
    ]
}