📄 Pagination

list endpoints that allow you to access large quantities of data come with optional pagination query parameters (pageSize and pageNum). When these two query parameters are entered together the format of the response changes.

{
  "objects":
    [{
      "id":"BTTR_623bdb8a0908408ba97b185138b12345",
      "internalId":"2f01d7946b9840ada8102633460bc5c0",
      "betRefreshRequested":null,
      "timeCreated":"2021-09-13T21:21:55.109355Z"
    },
    {
      "id":"BTTR_0afca19e264549d0882b115934112345",
      "internalId":"9dd5449d42d24ac3a11208fa5026256b",
      "betRefreshRequested":null,
      "timeCreated":"2021-09-13T20:54:52.970591Z"
    }],
  "totalPages":150
}

objects (list)

A response to a paginated endpoint will include a list of objects returned.

totalPages (integer)

A response to a paginated endpoint will include totalPages. You can access any page between 1 and totalPages using the pageNum query param.