Pagination

Pagination allows you to split the data into multiple "pages", where each API response includes a page of a specified number of data. For example, getting only the first 20 call transcripts per page.

Request query parameters

GET requests on collections can be sent with the following query parameters:

Property	Type	Description
limit	Number	Defines the maximum number of resources that can be included in the response. If not specified, the default per collection is used. Note: The actual number of returned resources may be less than the specified limit.
page	Number	Defines the page number to include in the response, where each page contains the number of rows according to the limit. If not specified, the response includes only the first page.

Request example

GET /api/v1/Calls?page=1&limit=10

Response

GET responses on collections include the pages field in the response body, for example:

  "pages": {
      "size": "10",
      "total": "1",
      "current": "1",
      "totalElements": "1"
  }

The field includes a JSON object with the following properties:

Property	Type	Description
size	String	Size of each page.
total	String	Total number of pages.
current	String	Current page number.
totalElements	String	Total number elements.