For all pagination types.The name of the parameter containing the number of items per page, in the request. Inserted in the query parameters for GET
/DELETE
, in the body for POST
/PUT
/PATCH
.
For all pagination types.The maximum number of items per page. If omitted, no limit will be sent to the external endpoint, relying on the endpoint’s default limit.
For all pagination types.The path of the field containing the results, in the response. If omitted or empty string, it defaults to the root. Use .
for nested fields, e.g. "results.contacts"
.
type
'cursor' | 'link' | 'offset'
required
For all pagination types.The pagination strategy.
For cursor pagination only (required).The path of the field containing the cursor for the next page, in the response. Use .
for nested fields, e.g. "pagination.cursor"
.
For cursor pagination only (required).The name of the parameter containing the cursor for the next page, in the request. Inserted in the query parameters for GET
/DELETE
, in the body for POST
/PUT
/PATCH
.
For link pagination (required unless link_path_in_response_body is specified).
The header containing the link to the next page, in the response.
link_path_in_response_body
For link pagination (required unless link_rel_in_response_header is specified).
The path of the field containing the link to the next page, in the response. Use .
for nested fields, e.g. "pagination.link"
.
For offset pagination only (required).The name of the parameter containing the offset for the next page, in the request. Inserted in the query parameters for GET
/DELETE
, in the body for POST
/PUT
/PATCH
.
For offset pagination only (optional).The initial offset. Defaults to 0, but some APIs start at 1.
offset_calculation_method
'per-page' | 'by-response-size'
For offset pagination only (optional).The offset calculation method. by-response-size
(default) means the offset is incremented by the number of results. per-page
means the offset is incremented by one for each page.
on_page
(paginationState: { nextPageParam?: string | number | undefined; response: AxiosResponse }) => Promise<void>
For all pagination types (optional).A callback function that is called after each page is fetched. Useful for logging or tracking pagination progress. The callback receives the next page parameter and the full Axios response object, which includes the response data, status, headers, and request configuration.