Pagination
Overview
To enhance API performance, several collection endpoints support pagination. To use this feature add a page and, optionally, a per parameter to the URL's query string. For example, the following URL will return the second page of fifty accounts of the company. If the per parameter is not provided, the API will return 10 records per page by default, unless otherwise specified.
https://api.accelerationcloud.com/api/v1/cores/unifi/accounts?page=2&size=50
The limit query parameter determines how many resources will be returned from a request. It defaults to 10 and accepts a maximum of 500.
Query Parameters
Parameter | Description | Example |
---|---|---|
size | The number of results to be returned. The maximum result set size is unlimited. | 100 |
page | The page locator; the current page where the response is located. | 3 |
Page Response Model
NAME | DESCRIPTION | EXAMPLE |
---|---|---|
"content" | The URL of the "next" page of the result set. Null if there are no additional pages. | "[{"name:"Alex"},{"name":"John"}]" |
"last" | Indicate it is the last page | "true" |
"totalElements" | Total elements of the query request | "48" |
"totalPages" | Total pages of the entire query request | "5" |
"numberOfElements" | Display how many elements in the current response | "0" |
Example
{
"code": 200,
"errorMessage": null,
"error": null,
"data": {
"content": [
{
"id": "1695352608936qwLty",
"accountName": "Alex Test Account",
"accountType": "API_Customer",
"businessEntityType": null,
"accountEmail": null,
"subRoutingNumber": null,
"subRoutingName": null,
"parentAccountId": null,
"accountNumber": null,
"accountStatus": "Active",
"tin": null,
"recordTypeId": "0125f000000qDHNAA2",
"billingStreet": null,
"billingCity": null,
"billingState": null,
"billingZipcode": null,
"billingCountry": null,
"mailingStreet": "Connector mailingStreet",
"mailingCity": "Connector mailingCity",
"mailingState": "Connector mailingState",
"mailingZipcode": "Connector mailingZip",
"mailingCountry": null,
"marketValue": null,
"createTime": "2023-09-22T03:16:48.941942"
}
],
"pageable": {
"sort": {
"sorted": false,
"unsorted": true,
"empty": true
},
"pageNumber": 0,
"pageSize": 10,
"offset": 0,
"paged": true,
"unpaged": false
},
"last": true,
"totalElements": 1,
"totalPages": 1,
"sort": {
"sorted": false,
"unsorted": true,
"empty": true
},
"first": true,
"number": 0,
"numberOfElements": 1,
"size": 10,
"empty": false
}
}
curl --location --request GET 'https://api-dev.fintechautomation.com/api/v2/services/company/users/permissions?size=15&page=8' \
--header 'Authorization: Bearer eyJraWQiOiItcm...'
Updated 12 months ago