Pagination
How to use pagination query parameters for graphiteConnect APIs that return large result sets.
Pagination
Some graphiteConnect public APIs may return large numbers of results. To ensure integrations run efficiently, APIs that can return large amounts of data support pagination via standard query parameters.
Pagination Parameters
| Parameter | Description |
|---|---|
limit | Maximum number of results to return per request. Maximum value: 1000. |
page | Which page of results to return. Pages are 0-indexed: page=0 returns results 1–1000, page=1 returns results 1001–2000, and so on. |
total | Returned in the response body. Indicates the total number of results available across all pages. |
Example Request
To fetch the second page of users with a page size of 500:
GET /api/public/api/v1/users?limit=500&page=1
Authorization: Bearer <your_access_token>Example Response
Paginated responses include a total field alongside the results array:
{
"total": 1250,
"results": [ ... ]
}Use total to determine how many pages are needed:
totalPages = Math.ceil(total / limit)APIs That Support Pagination
The following graphiteConnect public APIs support pagination:
| API | Description |
|---|---|
GET /users | Retrieve graphiteConnect users |
GET /users/roles | Retrieve user roles |
GET /tasks | Retrieve open tasks for supplier connections |
GET /users/events | Retrieve audit events for your organization |
When integrating with any of these APIs for organizations with large user bases or high activity volumes, always implement pagination to avoid timeouts or incomplete data sets.
Related Documentation
- User Data — User and roles APIs
- Tasks API — Fetching open tasks with pagination
- Events API — Fetching audit events with pagination
Updated about 7 hours ago