Pagination

Consume all objects by paging through data

All API calls to read multiple objects are implicitly paged and the response is a data envelope with information to navigate through the pages.

Parameters

The following variables are used as pagination parameters:

ParameterDescriptionDefault 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

Set these variables using query string parameters. All list endpoints support pagination unless otherwise noted.

Example:

GET https://alb.api.bridgeft.com/v2/account-management/accounts?limit=10&page=3

Will fetch the third page and retrieve up to 10 objects at a time.

Envelope response

When paging through data you'll receive data in an envelope, an outer structure with values to make navigating through the pages possible. The envelope has the following structure:

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

This envelope is saying there are 18 items available; 10 items are available per page, there are 2 pages and the data displayed in the data key is the first page. There is a next page but not a previous page.