Pagination

API methods that return a large number of items, will return them inside a paginated array. Onehub utilizes offset-based pagination. Some methods will respond to an offset parameter. To retrieve a complete set of paginated results, you perform multiple requests while increasing the offset. This can be passed in the body of the request or by appending ?offset= to the endpoint.

Pagination Example

GET https://ws-api.onehub.com/:endpoint?offset=1

Path Parameters

Name	Type	Description
:endpoint	string	The endpoint for the method you are hitting.

Query Parameters

Name	Type	Description
offset	integer	The number of items you want to move past in the response. Typically, this will be specified as a multiplier of the per_page amount.

Request Body

Name	Type	Description
offset	integer	The number of items you want to move past in the response. Typically, this will be specified as a multiplier of the per_page amount.

200

{
  "total_entries": 42,
  "current_page": 2,
  "total_pages": 2,
  "per_page": 30,
  "items": [
  ...
  ]
}