Pagination

Overview

The indexes of the /applications, /jobs, /files and /notes endpoints use pagination in order to reduce payload size. When you call either endpoint, only one page of the response will be returned with detail in the response headers for accessing additional pages.

By default, the API will return the 1st page of the response with 1000 results per page. These can be changed via optional page and per_page parameters.

For example, /jobs will return the 1st page with 1000 results per page, while jobs?page=2&per_page=500 will return the 2nd page with 500 results per page. The maximum number of results per page that may be requested is generally 5000, though for the /files endpoint the maximum is 1000.

Headers

Paginated results include a number of headers to help you navigate through all pages of the response. Headers include:

Header

Detail

Total-Count

The total count of results across all pages of the response.

Pages

The total number of pages in the response for a given number of results per page. If the Total-Count value is 2000 and the per_page value is set to the default 1000, then the Pages value will be 2.

Results-Per-Page

The number of results per page. Defaults to 1000, or may be set manually via the per_page parameter.

Current-Page

The current page of results being returned. Defaults to 1, or may be set manually via the page parameter.

First-Link

The URL for the first page of results for a given number of results per page.

Last-Link

The URL for the last page of results for a given number of results per page.