Realtime Cloud Storage

listItems

Retrieves items from a table.

This method will always cause a full table scan. If your table has a secondary key and you are filtering using the primary key the queryItems method should be used instead.

More about query vs scan

Sample

curl 'https://storage-backend-prd-useast1.realtime.co/listItems' -H 'Content-Type: application/json; charset=UTF-8' -d '{ "applicationKey":"[YOUR_APP_KEY]", "authenticationToken":"[YOUR_TOKEN]", "table":"SampleUser" }'

Parameters

String applicationKey

Public key of the application's license.

String privateKey optional

Private key of the application's license. For administration use only.

String authenticationToken

Identification of the user using the application.

String table

The name of the table.

String[] properties optional

Attributes that compose the item. If not present it will retrieve them all.

ListFilter[] filter optional

Evaluates the results and returns only the desired values. Multiple conditions are treated as "AND" operations: all conditions must be met to be included in the results.

DataKey startKey optional

The primary key of the item from which to continue an earlier operation. This value is returned in the stopKey if that operation was interrupted before completion; either because of the result set size or because of the setting for limit.

Number limit optional

The maximum number of items to evaluate (not necessarily the number of matching items).

ListItemsResponse callback

Function called when the operation completes.

Response

ListItemsResponse(data, error)

Response of the listItems operation.

Object data

Error error

The attribute that holds the results of the operation if an error occurred.