Pagination and Offset

CubiCasa API uses offset-based pagination with additional metadata to help clients navigate large datasets efficiently. The pagination response includes flags and offsets to indicate available pages.

Parameters

Parameter	Type	Description
has_more	Boolean	Indicates whether there are more records to fetch.
limit	Integer	The maximum number of records to return in one request. Default is 20.
next_offset	Integer	The offset value for the next page. If has_more is true, use this value for the next request.
previous_offset	Integer	The offset value for the previous page.

Notes

• The pagination object provides metadata for handling paginated responses.
• The has_more flag indicates whether additional pages exist.
• The next_offset should be used for retrieving the next page of results.
• The previous_offset helps navigate back to earlier results.

Example Requests

Requesting the First Page

GET /api/integrate/v3/orders?limit=20&offset=0

Requesting the Second Page

GET /api/integrate/v3/orders?limit=20&offset=21

Response Example

{
  "pagination": {
    "has_more": true,
    "limit": 20,
    "next_offset": 21,
    "previous_offset": 0
  },
  "items": [
    { }
  ]
}

Pagination in List APIs

All list-based API endpoints in CubiCasa use this pagination model to ensure efficient data retrieval. Please refer to the respective API documentation for further details.

For any questions or issues, please contact developer.support@cubicasa.com.