Skip to main content

Request a page

Collection endpoints return a results array and pagination information in meta. Use these query parameters:
Set SIIT_API_KEY to your API key in your local environment. The endpoint reference lists its available filters and sorting options.

Read the response

For example, a query with no matching requests returns:
count is the number of results in this response; total is the number matching the query across pages. When meta.next_page_link is not null, request that URL with the same Authorization header. The link preserves your filters and page size. Continue until next_page_link is null. previous_page_link is null on the first page.

Export larger datasets

The API rejects a request with HTTP 400 when page × per_page exceeds 100,000. For example, page 501 with per_page=200 is outside the supported range. Split larger exports using the endpoint’s supported timestamp filters or other filters, then paginate each subset separately. For a bounded request export:
Timestamp filters are strict before/after comparisons. Overlap adjacent time windows and deduplicate by UID to avoid missing records exactly on a boundary. Narrow a window further if it still exceeds the pagination limit. For incremental synchronization, use updated_after where supported. Collections can change while you paginate; use overlapping synchronization windows and deduplicate rather than treating pages as a fixed snapshot. Observe the rate limit when fetching successive pages.

The meta object

count
integer
current_page
integer
per_page
integer
default:20
Required range: x <= 200
total
integer