Pagination
Learn about the process of implementing pagination for handling bulk data requests to the Unified API.
Overview
Any data you interact with via the Bindbee API can be paginated, and this pagination is determined by the cursor
and page_size
query parameters.
Sample HTTP Request
Above is an example of an interactive HTTP request using the Bindbee API to demonstrate how pagination works:
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
Query Parameters
If provided, will only return employees for this manager.
The third-party API ID of the matching object.
If provided, will only return employees for this company
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
Whether to include the original data Bindbee fetched from the third-party to produce these models.
If provided, will only return employees with this employment status.
ACTIVE
, PENDING
, INACTIVE
, ACTIVE_EXTERNAL
, INACTIVE_EXTERNAL
If provided, will only return employees for this employee number
Number of results to return per page. Maximum size is 100.
1 < x < 1000
The pagination cursor value.
If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601)
Response
Cursor value to fetch next set of items
Indicates the count of items in the response