Resources returning many results are automatically paginated to optimize performance.
Using the _next Field
The _next field in the response contains the URL of the next page.
Paginated Response Example
Iterating Through All Pages
Basic Algorithm
- Make the first request
- Process the
items from the page
- Check if
_next is present and not empty
- If yes, request
_next and return to step 2
- If no, all pages have been retrieved
Python Example
Shell Example
Paginated Resources
The following resources are paginated:
- Job collection (
/restapi/v1/job)
- Candidate collection (
/restapi/v1/candidate)
- Job applications collection (
/restapi/v1/job/{id}/application)
- Candidate applications collection (
/restapi/v1/candidate/{id}/application)
- Step changes collection (
/restapi/v1/step)
- Notes collection (
/restapi/v1/note)
- Webhook history (
/restapi/v1/webhook/task)
Non-Paginated Resources
Some resources return all data in a single response:
- Job details (
/restapi/v1/job/{id})
- Candidate details (
/restapi/v1/candidate/{id})
- Application details (
/restapi/v1/application/{id})
- Job team (
/restapi/v1/job/{id}/team)
- Process list (
/restapi/v1/process)
Don’t try to guess page sizes or manipulate the pagination cursor. Always use the URL provided by _next.