The Osigu API uses pagination for endpoints that return large datasets. By default, the API will return a limited number of items per page, and you can control the pagination using query parameters such as page and size.
Query Parameters:
- page: The page number to retrieve (starting from 0).
- size: The number of items per page (default is 15).
Response Format: Paginated responses include the following metadata:
{
"content": [
{
"invoice_id": "uuid-of-invoice",
"invoice_number": "INV-001",
}
],
"page": {
"size": 10,
"total_elements": 100,
"total_pages": 10,
"number": 0
},
"links": [
{
"rel": "self",
"href": "/invoices?page=0&size=10"
},
{
"rel": "next",
"href": "/invoices?page=1&size=10"
}
]
}