Unless specified otherwise, the default page size for responses is 20 records. The size is limited to 100 for listing credentials, accounts, meters, statements, and sites. The size is limited to 5000 for listing providers. Specifying any number higher than that will still only return the maximum amount.

Specifying paging preference in the request

Here are the optional query path parameters for endpoints that support pagination.

Field	Default	Description
`page`	0	Specifies which page of results to return; this is 0-indexed
`size`	20	Specifies the size of the pages that are returned
`sort`	N/A	Defaults to ascending order unless otherwise specified. Ex. "sort=accountNumber,desc"

Response structure

"page": {
    "number": 0,
    "size": 0,
    "totalElements": 0,
    "totalPages": 0
  }

Field definitions

Field	Description
`number`	The index of page number being requested.
`size`	The number of elements on a page.
`totalElements`	The total number of elements across all pages.
`totalPages`	The total number of pages.

Examples

Getting the second page of size 100
https://api.arcadia.com/v2/utility/providers?size=100&page=1
Sorting providers by 'providerName' ascending
https://api.arcadia.com/v2/utility/providers?page=0&sort=providerName,asc
Sorting a result set by two different fields
https://api.arcadia.com/v2/utility/accounts?page=0&sort=providerName,asc&sort=accountNumber,desc