Using the API
Pagination
page and page_size on list operations, and what next and prev mean.
List operations that document pagination take two query parameters:
| Parameter | Meaning |
|---|---|
page | The page number to return. |
page_size | How many results to return on that page. |
The JSON body includes:
| Field | Meaning |
|---|---|
count | Total number of items in the collection. |
size | Number of items on this page. |
results | The page of items. |
next | The next page number, or null on the last page. |
prev | The previous page number, or null on the first page. |
next and prev are page numbers, not URLs. Request page set to next until next is null.
search is a separate query parameter on the lists that document it, including businesses. The reference page for each list names which fields search matches. Do not assume every list searches the same fields.
Filters such as status on invoices or type on accounts are also query parameters. They are documented on that operation, not here.