- Type:
integer
- Default:
null
- Scope:
settings,search
offset
parameter specifies the zero-based index of the first record to return.
Use it with length
to retrieve a specific subset of results.
This is useful when implementing offset-based pagination—an alternative to using page
and hitsPerPage
.
For example, to fetch records 50 through 80, set offset
to 49
and length
to 30
.
Usage
- Zero-based: the tenth record is at offset 9.
- If
offset
is omitted,length
is ignored. - If
offset
is specified butlength
omitted, the number of records returned is equal tohitsPerPage
.
offset
and length
, the response includes these fields:
Example
Current API clients
Current API clients
Legacy API clients
Legacy API clients