Purpose: Get a list of form submissions

Developers
1

Hi
I try to export List Forms by : Base URL: https://www.commcarehq.org/a/[domain]/api/v0.5/form/
and it is work but in our project more than 1 million records and limit "The maximum number of records to return. Default: 20. Maximum: 1000"
how we can increase the Maximum number
Thanks

2

That number is maximum limit for each page. You will need to make iterative calls to the API to get all the project's data.

The recommended method of doing the pagination is to use the indexed_on date field. This requires ordering by the indexed_on field and then using the indexed_on_start filter to get successive pages:

Your first request might look like this:

/a/[domain]/api/v0.5/form/?order_by=indexed_on

And successive requests would add the filter:

/a/[domain]/api/v0.5/form/?order_by=indexed_on&indexed_on_start=[date]

For the date parameter you should use the indexed_on value from the last record in the previous page.

1 Like