Skip to main content
Version: 6.0.10

API Pagination | Interactor

Overview

Interactor® GET API endpoint allows for fetching paginated data using the GET method.
The pagination is controlled via offset and limit parameters.

Endpoint

GET /api/data

Parameters

  • offset (integer, required): The starting point from which records are fetched. Default is 0.
  • limit (integer, required): The number of records to fetch. Default is 10.

Response

The response will include the paginated data along with metadata about the pagination.

Response Example

[
{
"id": 1,
"name": "Item 1",
"description": "Description for item 1"
},
{
"id": 2,
"name": "Item 2",
"description": "Description for item 2"
}
// More items...
]

Example Requests

Example 1: Fetching the first 10 records

GET /api/data?offset=0&limit=10

Example 2: Fetching the next 10 records (11-20)

GET /api/data?offset=10&limit=10

Notes

  • The offset parameter is zero-based, meaning an offset of 0 starts at the first record.
  • Adjust the limit parameter to control the number of records returned per request.
  • Always check the pagination object in the response to understand the total number of records available and the current offset and limit.