Pagination

The API supports pagination to manage large sets of data efficiently. You can use the following query parameters to control pagination:

  • page: The page number to retrieve. Defaults to 1 if not provided.
  • pageSize: The number of records to return per page. Defaults to 25 but cannot exceed 50.

How Pagination Works

  • Calculation of from: The from parameter is calculated as (page - 1) * pageSize. This determines the starting point of the records to be retrieved for the specified page.

  • Total Count and Pages:

  • The total number of records (totalCount) is determined from the search query results.

  • The total number of pages (totalPages) is calculated by dividing totalCount by pageSize and rounding up.

  • Max amount of records is 50

Example Request

To request the second page of results with 10 records per page:

curl -G https://app.companydata.com/api/company/search \
  -H "x-api-key: {ApiKey}" \
  -d "page=2&pageSize=10"

Was this page helpful?