Learn how to efficiently retrieve large datasets in API v2 from QuickBooks Desktop using cursor-based pagination.
cursor
query parameter in the API specification), the process works as follows:
limit
query parameter to control how many items are returned per page.
150
items per page. We enforce this limit to prevent overloading QuickBooks Desktop.nextCursor
- The cursor value to use when requesting the next page of results. This field is null
if there are no more pages.hasMore
- Indicates whether there are more pages of results available.remainingCount
- The number of remaining items that can be retrieved in subsequent pages.cursor
query parameter set to the nextCursor
value from the previous response.
hasMore
is false
.
hasMore
is false
will result in an error.
cursor
value used for all pagescursor
value remains constant throughout the entire pagination sequence. This means you should reuse the same cursor value for all subsequent requests in the sequence, which is a design characteristic inherent to the QuickBooks Desktop system.
cursor
parameter in their API specification. This typically applies to endpoints where the end-user is highly unlikely to have a large set of objects of that type, so the absence of pagination will not impact performance.
cursor
query parameter:
hasMore
is false
will result in an error: