Optional
categoryOptional
columnColumn for alternative sorting. This requires the list to be designed for indexing on this column
Optional
countHow many entries shall be returned, default = 1000
Optional
directionThe direction for alternative sorting. This is ignored unless "column" query parameter is passed as well. This requires the list to be designed for indexing on this column in the desired direction. Defaults to ascending if column is set.
Optional
distinctDetermines whether, when documents=true, only distinct documents should be retrieved if they exist multiple times in the list.
Optional
documentsShall the query return documents instead of view entries
Optional
ftFull-text search query to filter the contents of the list
Optional
keyUseful for categorized or sorted lists. Limits return values to entries matching the key or keys. Use multiple key parameter items to specify multiple keys in request URL. The keys specified must be in the same order as the sorted columns from left to right. Unsorted columns will be ignored.
Optional
keySelect by partial Key. Default is false (key match is exact)
Optional
keyThe type of the keys used in startKey and untilKey
Optional
markWhen retrieving documents instead of view entries, mark them as read by the current user after retrieval
Optional
markWhen retrieving documents instead of view entries, mark them as unread by the current user after retrieval
Optional
metaWhen set to false, all metadata Json items on the top level of an object get suppressed. Default is true
Optional
metaAdditional metadata that is not included in the View. This may have a slight performance cost so use only if necessary.
Optional
modeDocument mode to retrieve the documents with. (Every Form can have multiple modes, each can be different from other modes). Also, Current logged-in user must have access for the specified mode.
Name of the column to provide the data for the pivot aggregator
Optional
richThe format RichText fields will be returned when retrieving documents instead of view entries. The default if unspecified is mime.
Optional
scopeWhat shall the view return:
Optional
startAt which entry should return values start (zero based), default = 0
Optional
startKey value for the first entry to retrieve. This is treated as a greater-than-or-equal lookup
Optional
startsA character combination to perform a partial match to identify a starting point. The character combination will be applied to the "column" and "direction" passed in the query string. This cannot be combined with the "keys" parameter, i.e. you cannot filter on keys and startwith within that key.
Optional
unreadRetrieve only unread entries. Cannot be combined with documents=true, documentsOnly=true, or methods to select or query documents
Optional
untilKey value to stop traversal when used in combination with startKey. This is treated as a greater-than-or-equal lookup and represents the first value to not return
Category to restrict view queries to