Placewise API
Get startedExplore
Get startedExplore
Performance Cloud 🗗
Placewise 🗗
  1. Common Concepts
  • Introduction
  • Global Headers
  • Common HTTP Error Codes
  • API Permits
  • Rate Limiting
  • Authorization
    • Token Authorization
    • Member Authorization
    • User Authorization
  • API Contexts
    • Customer Context
    • LoyaltyClub Context
    • Global Context
  • Common Concepts
    • Localization
    • System URLs
    • Params Validation
    • Pagination
    • Sorting
  • Common Models
    • Common Data Formats
    • Member Model
    • API Entity Model
    • Opening Hours Model
  1. Common Concepts

Pagination

Most of the actions that list multiple records, have common interface for paginating them.

Pagination params#

Following query params allow to control the returned results lists.
KeyTypeDescription
page_nointegerNumber of results page (default: 1)
per_pageintegerNumber of results that should be returned per request (default: depends on the endpoint)

PaginationInfo object#

The paginated response along with returned records will also contains also a PaginationInfo object.
It contains information about paginated records list. May be used to traverse the list.
KeyTypeDescription
total_countintegerNumber of all available results
per_pageintegerNumber of results returned per request
total_pagesintegerNumber of all available pages
current_pageinteger
next_pageintegerNext available page (null when it's a last page)
prev_pageintegerPrevious available page (null when it's a first page)
is_first_pageboolean
is_last_pageboolean
is_out_of_rangebooleanIs given per_page param out of range?

Example#

Example API response containing records and PaginationInfo object:
{
  "records": [
    // (...)
  ],
  "pagination_info": {
    "total_count": 2050,
    "per_page": 1000,
    "total_pages": 3,
    "current_page": 1,
    "next_page": 2,
    "prev_page": null,
    "is_first_page": true,
    "is_last_page": false,
    "is_out_of_range": false
  }
}
Previous
Params Validation
Next
Sorting
Built with