Retrieving larger amounts of data.
meta
: the information about the response.<items>
: the list of items for the respective request, where items
is named according to the respective
type of data being requested - e.g., patients
, documents
.meta
contains:
itemsOnPage
: the amount of items on the current page.itemsInTotal
: (optional) the total amount of items in all pages - only available on the first page.nextPage
: (optional) the URL to return the next page; if not present, it means there’s not a next page
prevPage
: (optional) the URL to return the previous page; if not present, it means we’re on the first page.prevPage
), with the default number of items
per page. We can see the total amount of items included (113
).
nextPage
. When there’s no nextPage
, it means we’re
on the last one. As simple as that.
count
: the number of items to be included in each page/response, optional. Defaults to 50 items per page.
The maximum number of items per page is 500.fromItem
: the ID of the first item to be included in the current page, optional. If not provided, the
first page will be returned.toItem
: the last item to be included in the current page, optional. If not provided, it will
automatically be calculated based on firstItem
and count
.