API Docs

Get Record List Query (with order by, limit, offset)

Get Record List Query (with order by, limit, offset) - kintone.app.getQuery()

Retrieves the record list filter conditions as a query string, including "order by", "limit" and "offset"

Function

Desktop

kintone.app.getQuery()

Mobile

kintone.mobile.app.getQuery()

Parameters

None

Returns

  • String or null.
  • Null is returned for pages where it cannot be used.
  • If there are no filter conditions on the record list, a query list with only "order by", "limit" and "offset" will be returned.
  • If there are no sort conditions on the record list, a query list with only "limit" and "offset" will be returned.

Sample Request 

1
2
3
4
5

var query = kintone.app.getQuery();
console.log(query);

// returns
// 'record_id <= "5" and creator in ("john-d") order by record_id desc limit 5 offset 10'

Available Pages

  • Record List
  • Graph

Notes

  • An error occurs if the query string contains any of the following:
    • Deleted or non-existent options in the following fields (Desktop only):
      • Drop-down
      • Radio button
      • Multi-choice
      • Check box
    • Deleted or non-existent statuses (Desktop only)