API Reference (hyper cloud)
Data API
List Documents
8min
Returns the list of documents from the hyper data service.
- appname - string - path parameters
- servicename - value requirements
- limit - {number} default: 1000 - limits the number of documents returned
- startkey - {string} key matcher for document id's
- endkey - {string} key matcher for document id's
- keys - {string} a comma delimited list of key ids for returning documents. Ex: 'keys=movie-1, movie-2'
- descending - {true|false} - determines the order of the list sorted on the 'id' column
This example requests a list of movie documents.
Don't forget!
Be sure to set your HYPER environment variable with the value of your hyper app's connection string.
Node.js
Curl
|
Status Code | Description | Example Response |
200 | Successfully returned list of documents | {"ok": true} |
500 | Error has occurred | {"ok": false, "msg": "..."} |
Need Help?
You can always reach out to our support team for any additional assistance on slack.

Updated 10 May 2022
Did this page help you?