WealthTech API platform supports a standard pagination method. All APIs responses include an envelope with meta data that will help you to paginate through the response.

Pagination Parameters

The following variables are used as pagination parameters:

Parameter	Description	Default Value
`pager.limit` integer	Maximum page size. Must be between 1 and 100,000	10,000
`pager.page` integer	Page number to fetch Must be greater than zero	1

We strongly recommend setting these variables while calling endpoints that return a large amount of data, especially Source Positions API and Source Lots API.

Request Example

The following request will fetch the third page of the Accounts list and up to 10 objects on the each page:

curl --request GET \
--url 'https://api.bridgeft.com/v2/account-management/accounts?pager.limit=10&pager.page=3' \
--header 'Authorization: Bearer {YOUR_TOKEN}'

Response Envelope

When using pagination, you will receive enveloped data that contains the number of retrieved items and pages as part of the each API response. This will allow you to paginate the response.

The typical envelope has the following structure:

{
    "object": "list",
    "has_next": true,
    "has_previous": false,
    "current_page": 1,
    "total_pages": 3,
  	"page_size_limit": 10,
  	"total_items": 28,
    "data": [{
        "object": "<object type>",
        ...
    }]
}

This example envelope shows that 28 items have been retrieved in total; there are a total of 3 pages and each page contains 10 items maximum. The data returned in the data key is the 1st page only. has_next indicates there is a next page available while has_previous indicates there is no previous page.