Paginated list

Our API uses simple pagination to represent collections of items with variable length (such as the Inbox list endpoint).

The  metadata object contains information you can use to traverse collections.


This resource includes the following properties:

Property Type Description
entries array An array of resource objects.
metadata object An object containing pagination metadata.
↳  current_page integer The currently requested page.
↳  per_page integer The number of results per page.
↳  total_entries integer The total number of resources.
↳  total_pages integer The total number of pages the resources span.


Here is an example representation of this resource:

  "entries": [
    { "id": 1 },
    { "id": 2 }
  "metadata": {
    "current_page": 1,
    "per_page": 10,
    "total_entries": 4,
    "total_pages": 1