Performance considerations - Async vs Sync

For asynchronous calls you will need to provide a callback endpoint that will receive the API response payloads and handle further paging requests as required.

As a general rule it is recommended that you don't exceed a page size of 1000 records per request, regardless of whether you are using the synchronous or asynchronous API calls.

This is subject to multiple variables and you may find with testing that you are able to increase the page size, or you may need to decrease it, depending on your requirements, environment and test results.

There is 30 sec timeout on the synchronous calls, and you will receive a message advising you to either decrease your page size or use the asynchronous API if this is exceeded.

There is a 90 sec timeout on each asynchronous call.

Testing has shown that it takes about 3min to retrieve 80 000 records via the asynchronous calls (equating to 80 calls of 1000 records each)