This site has been archived. Please visit help.fulcrumapp.com for our new support documentation and contact information.

Pagination

keith's Avatar

keith

11 Nov, 2016 07:29 AM

The help text API introduction says:

All of the index views use pagination. The following information will be returned in the root object to help you determine where you are in the query:

{
  "current_page": 1,
  "total_pages": 1,
  "per_page": 50
}

From this. I expected that if a large number of JSON records are returned for an API call, it would be necessary to ask for these and pass the page number for the records required. It seems however that when I call "fulcrum.records.search", even if there are over 10,000 records, these are all returned.

I think for some SAAS apps APIs, (e.g. Xero), this is the norm to avoid people killing the performance of the system for other users

I am not sure what index views are, could you please clarify this area, and indicate if there are any limits that I might hit?

  1. 1 Posted by Bryan McBride on 11 Nov, 2016 12:46 PM

    Bryan McBride's Avatar

    Hi Keith,

    The default 'per_page' value is set to the max of 20,000. You can set a more appropriate value using the 'per_page' and 'page' URL query parameters.

  2. 2 Posted by keith on 12 Nov, 2016 08:39 PM

    keith's Avatar

    Thanks Bryan

Keyboard shortcuts

Generic

? Show this help
ESC Blurs the current field

Comment Form

r Focus the comment reply box
^ + ↩ Submit the comment

You can use Command ⌘ instead of Control ^ on Mac