website logo
⌘K
πŸ–οΈIntroduction to hyper cloud
🍎Getting Started
😍What's New
Blueberry Migration Guide
πŸ’ͺWorkshops
Deno Workshops
NodeJS Workshops
⚑Quickstarts
NodeJS Quickstarts
πŸ”ŒAPI Reference (hyper cloud)
🍎Basics
⚑hyper connect
πŸ”‘JWT Auth
πŸ’ΎData API
🏎️Cache API
πŸ”ŽSearch API
πŸ—„οΈStorage API
πŸ€“Queue API
πŸ”“Sign In
⚑Applications
βš™οΈSettings
πŸ”‘App Keys
πŸ‘₯Teams
Switching Between Accounts
Application Services
Application Service Instances
Adding a Queue Service
Adding a Search Service
Subscriptions
πŸ€‘Upgrade
πŸ“•Terminology
Parameters
πŸ’³Billing
Payment and Pricing Terms
πŸ’ΌLegal
Terms of Service
Acceptable Use Policy
Privacy Policy
πŸ•ΆοΈHyper Vision
Docs powered byΒ archbeeΒ 
11min

List Documents

GET /{appname}/data/{servicename}

Returns the list of documents from the hyper data service.

Parameters

Path

  • appname - string - path parameters
  • servicename - value requirements

Querystring parameters [optional]

  • 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

Examples

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
|

Responses

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?
Yes
No
UP NEXT
Create an Index
Docs powered byΒ archbeeΒ 
TABLE OF CONTENTS
GET /{appname}/data/{servicename}
Parameters
Path
Querystring parameters [optional]
Examples
Don't forget!
Responses
Need Help?