Pagination

List endpoints return large result sets in pages. Use the limit and offset query parameters to control how many records you pull in each request and to page through the results.

To speed up large data pulls by sending requests in parallel, see Concurrency.

Query parameters

Parameter	Description	Default
limit	Number of records to return in one request.	10
offset	Number of records to skip before the first returned record.	0

The maximum limit is usually 100, but it varies by endpoint (for example, some endpoints allow up to 50 or 200). Check the limit parameter on the endpoint page in the API reference.

Paging through results

When requesting a large number of records, a single large request may be interrupted or truncated. Break it up into multiple smaller requests instead.

Example: You want to retrieve 1,000 purchase orders (POs). Instead of making one large request, make ten requests of 100 POs each:

Request	Parameters	Returns
1	offset=0&limit=100	POs 1–100
2	offset=100&limit=100	POs 101–200
…	…	…
10	offset=900&limit=100	POs 901–1,000

curl --url "https://sight.inspectorio.com/api/v1/purchase-orders?offset=100&limit=100" \
  --header "apiKey: <YOUR_API_KEY>"

Most list endpoints return the pagination values and the total number of matching records along with the data:

{
  "data": [ ... ],
  "limit": 100,
  "offset": 100,
  "total": 1000
}

Keep requesting the next page (offset + limit) until offset reaches total.

note

A few endpoints use a different response format. For example, some return count with next and previous links, and the V3 List Purchase Orders endpoint returns a plain array. Check the response schema on the endpoint page.

Syncing only what changed

Instead of pulling all records every time, use the date-range filters available on many list endpoints to pull only records created or updated since your last sync. For example:

• List Purchase Orders (V3): updated_from and updated_to
• List Reports: updated_from and updated_to

Parameter names and date formats vary by endpoint. Check the endpoint page for the exact filters it supports.