Skip to main content

Pagination

List endpoints support pagination to manage large result sets.

Request Parameters

ParameterTypeRequiredDefaultConstraintsDescription
pageintegerYes1Must be a positive integer (≥ 1)Page number
per_pageintegerYes20Min: 10, Max: 100Items per page
caution

per_page must be between 10 and 100. Values outside this range will return a 400 Bad Request error.

Response Format

{
"message": {
"key": "RES000000",
"value": "success"
},
"data": {
"items": [...],
"total_count": "150",
"page": "1",
"per_page": "20"
}
}

Usage Example

# Retrieve page 2 with 20 items per page
curl -X GET "https://api.example.com/partner/website/all?page=2&per_page=20" \
-H "X-Cloudbric-Key: <API_KEY>"